apg-conv-api - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "apg-conv-api",
-  "version": "1.0.0",
-  "description": "API for converting integer arrays to encoded byte streams (Buffers) and vice versa.",
+  "version": "1.0.1",
+  "description": "(Deprecated: use apg-js instead.) API for converting integer arrays to encoded byte streams (Buffers) and vice versa.",
   "scripts": {
@@ -6,0 +6,0 @@ "test": "echo \"Error: no test specified\" && exit 1"

README.md

 # apg-conv-api
+
+_**Deprecated:** Use [apg-js](https://www.npmjs.com/package/apg-js) instead. See [apg-js-examples](https://www.npmjs.com/package/apg-js-examples) for usage._
+
 **apg-conv-api** is the API for [**apg-conv**](https://github.com/ldthomas/apg-conv).
@@ -7,17 +10,25 @@ It provides the functions for disassembling the data types as well as the encoding and decoding functions.
 It also provides access to the low-level transformation functions which actually do the encoding and decoding.
-These can be found in the `./src/transformers.js` file. 
+These can be found in the `./src/transformers.js` file.
+
 ### node.js applications
+
 In your project directory:
-````
+
+```
 npm install apg-conv --save
-````
+```
+
 In your application code, for example:
-````
+
+```
 var apgConv = require("apg-conv-api");
 var buf = apgConv.converter.decode("UTF8", chars);
-````
+```
+
 ### HTML applications
+
 **apg-conv-api** has been bundled (with [webpack](https://webpack.js.org/)) for use in web page applications.
 Use one of the script links:
-````
+
+```
 <script src="./apg-conv-api.js"></script>
@@ -27,5 +38,7 @@ or
 
-````
+```
+
 This will give you access to **apg-conv-api** in your web page JavaScript through the functions and objects:
-````
+
+```
 apgConv.convert()
@@ -36,3 +49,4 @@ apgConv.encode()
 apgConv.Buffer
-````
+```
+
 Besides the high-level conversion, encoding and decoding functions, `apgConv.transformers` gives access to all of the low-level functions.
@@ -44,5 +58,7 @@
 
-## Documentation:  
+## Documentation:
+
 The documentation is in the code in [`docco`](https://jashkenas.github.io/docco/) format.
 To generate the documentation, from the **apg-conv-api** package directory:
+
 ```
@@ -52,9 +68,9 @@ npm install -g docco
 ```
+
 View `docs/index.html` in any web browser to get started.
 
 **Copyright:**  
-  *Copyright &copy; 2017 Lowell D. Thomas, all rights reserved*  
+ _Copyright &copy; 2017 Lowell D. Thomas, all rights reserved_
 
 **License:**  
 Released with the BSD-3-Clause license.
-      

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

185646

increased by0.1%

Number of lines in readme file

72

increased by28.57%

No dependency changes