countingup 0.0.1 → 0.1.1

package/README.md

@@ -0,0 +1,60 @@
+# Countingup
+Countingup is a simple but useful math library for JavaScript.
+## Installation
+Using npm:
+```
+$ npm install countingup
+```
+
+In Node.js
+```javascript
+const countingup = require('countingup')
+```
+
+# Counter class
+The ``Counter`` class provides a tool to count numbers.
+
+Initializing
+```javascript
+const Counter = countingup.Counter
+const myCounter = new Counter()
+```
+
+Counting
+```javascript
+myCounter.count()
+console.log(myCounter.getCurrentNumber()) // 1
+```
+
+Resetting
+```javascript
+myCounter.reset()
+console.log(myCounter.getCurrentNumber()) // 0
+```
+
+# Bonus Features
+Customizing the Increment
+```javascript
+myCounter.count()
+console.log(myCounter.getCurrentNumber()) // 1
+myCounter.count(3)
+console.log(myCounter.getCurrentNumber()) // 4
+```
+
+Customizing the Direction
+This allows you to change the direction so it counts down and subtracts
+```javascript
+myCounter.reset()
+myCounter.count(5)
+console.log(myCounter.getCurrentNumber()) // 5
+myCounter.count(5, 'reverse') // 0
+```
+
+Customizing the Starting Number
+
+```javascript
+const myCounter2 = new Counter(4)
+console.log(myCounter2.getCurrentNumber()) // 4
+myCounter2.reset(3)
+console.log(myCounter2.getCurrentNumber()) // 3
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "countingup",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "description": "Math Utils for JavaScript",
   "main": "index.js",
   "directories": {
@@ -8,5 +8,12 @@
   },
   "scripts": {},
   "author": "Samuel Fox J.",
-  "license": "UNLICENSED"
+  "license": "UNLICENSED",
+  "keywords": [
+    "math",
+    "js",
+    "utils",
+    "problems",
+    "calculations"
+  ]
 }