while2 1.0.0 → 2.0.0

package/README.md

@@ -1,47 +1,32 @@
-# While2
+# `while2`
+`while2` is a while statement, but 10x and function-oriented. Also, it includes a built-in index value.
 
-### What is while2
-While2 is while statements, but different syntax. Also it includes a built-in index value.
-
-```javascript
-const w2 = require('./lib/while2')
-
-new w2(true)
-  .do((i, breakLoop) => {
-    if (i > 3) breakLoop() // prints 0, 1, 2, 3 then stops
-    console.log(i)
-  })
-  .end()
+## Installation
+```bash
+$ npm install while2
 ```
-### Installation
 
-```npm install while2```
+## Usage
 
-```javascript
-const w2 = require('while2')
-```
-
-### Syntax
-
-To use while2, first import the module. It is recommended to call it "w2".
+To use while2, first import the module. It is recommended to call it `w2`.
 
 ```javascript
 const w2 = require('while2')
 ```
 
-For every while2 statement, you will create a new instance of w2, as it is a class, and pass a condition, and for everything that you want to run while the condition is true, put .do() and then pass in a function in the parentheses. Always type .end() at the end to run the while loop in the background.
+For every while2 statement, you will create a new instance of `w2`, as it is a class, and pass a condition. For everything that you want to run while the condition is true, put `.do(...)` and then pass in a function in the parentheses. Always type `.end()`at the end to run the while loop or it won't work
 
 ```javascript
 const w2 = require('while2')
 
-new w2(true)
+new w2(true) // equivalent to while (true)
   .do(() => {
     // anything here will run again and again forever
   })
   .end() // this line makes sure that the while loop is ran in the background. if you don't include this nothing will happen
 ```
 
-### Features: Builtin Index
+### Built-in index
 
 While2 includes an i parameter that will automatically increment every time the do function is run.
 
@@ -55,12 +40,12 @@ new w2(true)
   .end()
 ```
 
-### Features: BreakLoop Function
+### Breaking the loop
 
-While2 includes a breakLoop parameter function so that you can break your while loop.
+While2 includes a `breakLoop` parameter function so that you can break your while loop.
 
 ```javascript
-const w2 = require('./lib/while2')
+const w2 = require('while2')
 
 new w2(true)
   .do((i, breakLoop) => {
@@ -68,4 +53,7 @@ new w2(true)
     console.log(i)
   })
   .end()
-```
+```
+
+## License
+No license, do whatever you want

package/index.js

@@ -1 +1,32 @@
-module.exports = require('./lib/while2')
+const breakError = {}
+
+class w2 {
+  constructor(condition) {
+    if (!this instanceof w2) return new w2()
+    this.condition = condition
+    this.i = 0
+    return this
+  }
+  do(cb) {
+    this.doHandler = cb
+    return this
+  }
+  end() {
+    try {
+      while (this.condition) {
+        this.doHandler(this.i, () => {
+          throw breakError
+        }) // pass in the function to break the loop
+        this.i += 1
+      }
+    } catch(err) {
+      if (err === breakError) return
+
+      throw err
+    }
+  }
+}
+
+
+
+module.exports = w2

package/package.json

@@ -1,14 +1,29 @@
 {
   "name": "while2",
-  "version": "1.0.0",
-  "description": "for when while loops aren't verbose enoughs",
+  "version": "2.0.0",
+  "description": "10x while loop",
+  "keywords": [
+    "while",
+    "while2",
+    "declaration",
+    "statement"
+  ],
+  "homepage": "https://github.com/10xEngineersQualityProgramming/while2#readme",
+  "bugs": {
+    "url": "https://github.com/10xEngineersQualityProgramming/while2/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/10xEngineersQualityProgramming/while2.git"
+  },
+  "license": "UNLICENSED",
+  "author": "me",
+  "type": "commonjs",
   "main": "index.js",
   "directories": {
     "lib": "lib"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "me",
-  "license": "UNLICENSED"
+  }
 }

package/lib/while2.js

@@ -1,32 +0,0 @@
-const breakError = {}
-
-class w2 {
-  constructor(condition) {
-    if (!this instanceof w2) return new w2()
-    this.condition = condition
-    this.i = 0
-    return this
-  }
-  do(cb) {
-    this.doHandler = cb
-    return this
-  }
-  end() {
-    try {
-      while (this.condition) {
-        this.doHandler(this.i, () => {
-          throw breakError
-        }) // pass in the function to break the loop
-        this.i += 1
-      }
-    } catch(err) {
-      if (err === breakError) return
-
-      throw err
-    }
-  }
-}
-
-
-
-module.exports = w2

package/test.js

@@ -1,7 +0,0 @@
-const w2 = require('./lib/while2')
-new w2(true)
-  .do((i, breakLoop) => {
-    if (i > 3) breakLoop()
-    console.log(i)
-  })
-  .end()