531 - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "531",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Given a 1RM, generate a 4 week 5/3/1 cycle",
@@ -18,4 +18,16 @@ "main": "./src",
   },
-  "keywords": ["531", "weightlifting"],
-  "homepage": "https://github.com/bendrucker/531.js"
+  "keywords": [
+    "531",
+    "weightlifting"
+  ],
+  "homepage": "https://github.com/bendrucker/531.js",
+  "dependencies": {
+    "round": "~1.0.0",
+    "xtend": "~4.0.0"
+  },
+  "devDependencies": {
+    "chai": "~1.10.0",
+    "istanbul": "~0.3.2",
+    "mocha": "~2.0.1"
+  }
 }

README.md

 531.js
 ======
 
-Given a 1RM, generate a 4 week 5/3/1 cycle
+Given a 1RM, generate a 4 week 5/3/1 cycle. 
+
+## Setup
+```bash
+$ npm install 531
+```
+
+## API
+
+#### `fto(max, [options])` -> `Array`
+
+Given a `max` (Number), generates an array of weeks. Each week has:
+
+* `name`: The name of the week, e.g. "Week 1"
+* `sets`: An `Array` of sets
+
+Each set has:
+
+* `ratio`: (Number) The ratio of the 90% 1RM to use for that set
+* `repetitions`: (Number) The number of repetitions to perform
+* `weight`: (Number) The total weight to use
+* `max`: (Boolean) Whether that set should be performed for the maximum number of sets possible
+
+`options` may contain:
+
+* `round`: Defaults to `'down'`. Set to `'up'` to round up to the nearest increment
+* `increment`: Defaults to `5`. Sets the increment to use when rounding weights.
+* `use90`: Defaults to `true`. Set to `false` to use 100% of your 1RM for calculations.
+
+## Example
+
+```js
+var fto   = require('531');
+var cycle = fto(455);
+
+console.log('Next cycle, my first deadlift will be:', cycle[0].sets[0].weight, 'lbs');
+```

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6409

increased by181.71%

Number of package files

8

increased by100%

Lines of code

129

increased byInfinity%

Number of lines in readme file

41

increased by720%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

3

increased byInfinity%

Dependency changes

• + Addedround@~1.0.0

• + Addedxtend@~4.0.0

• + Addedround@1.0.1(transitive)

• + Addedxtend@4.0.2(transitive)