cannonian - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

@@ -12,3 +12,3 @@ {
   ],
-  "version": "0.0.3",
+  "version": "0.0.4",
   "dependencies": {
@@ -15,0 +15,0 @@ "antr": "*"

README.md

@@ -10,4 +10,8 @@ Cannonianjs API
 ###In Node.js
+Install using:
 	npm install cannonian
 
+Include using:
+	var cannonianjs = require('cannonian');
+
 ##Usage
@@ -26,12 +30,12 @@
 ###Functions
-* .conv(p, fromType, toType) - converts between types
-  p - optional. parameter to convert. if not given, will use the cannonian object that the function is being called from.
-  fromType - optional. type of object currently. if not given, type will be calculated.
-  toType - optional. type you wish to convert to. if not given, will return cannonianjs object.
+####.conv(p, fromType, toType) - converts between types
+  - p - optional. parameter to convert. if not given, will use the cannonian object that the function is being called from.
+  - fromType - optional. type of object currently. if not given, type will be calculated.
+  - toType - optional. type you wish to convert to. if not given, will return cannonianjs object.
 
-* .getType(p) - returns the type of the given parameter.
-  p - optional. parameter. if not given, will use the cannonian object that the function is being called from.
+####.getType(p) - returns the type of the given parameter.
+  - p - optional. parameter. if not given, will use the cannonian object that the function is being called from.
 
-* .parse(type, p) - translates object into cannonianjs object style format
-  type - required. type of the parameter given
-  p - parameter to convert
+####.parse(type, p) - translates object into cannonianjs object style format
+  - type - required. type of the parameter given
+  - p - parameter to convert

No alert changes

Improved metrics

Total package byte prevSize

39972

increased by0.23%

Number of lines in readme file

39

increased by11.43%

No dependency changes