is-prime-number - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

package.json

 {
   "name": "is-prime-number",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Returns boolean of if provided number is prime.",
@@ -15,3 +15,4 @@ "main": "index.js",
     "prime",
-    "primality"
+    "primality",
+    "math"
   ],
@@ -18,0 +19,0 @@ "author": "Bradley Flood <[e-mail]> (https://bradleyflood.com)",

README.md

 # IsPrimeNumber - JavaScript
 
-## Installation
+The `is-prime-number` module determines whether the passed value is a prime number.
+
 ```bash
@@ -8,7 +9,21 @@ npm install is-prime-number
 
-## Usage
+### Syntax
 ```javascript
-const {isPrime} = require('is-prime-number');
+isPrime(value)
+```
+#### Parameters
+- `value` The value to be tested for being a prime number.
+
+#### Return value
+A `boolean` indicating whether or not the given value is a prime number.
+
+### Examples
+```javascript
+const isPrime = require('is-prime-number');
+
+console.log( isPrime(2) ); // true
 console.log( isPrime(7) ); // true
+
 console.log( isPrime(20) ); // false
+console.log( isPrime({}) ); // false
 ```

No alert changes

Improved metrics

Total package byte prevSize

15817

increased by9.62%

Number of lines in readme file

29

increased by107.14%

No dependency changes