Merge pull request #23 from KirbyPaint/readme

Readme

README.md

@@ -18,11 +18,51 @@ yarn add nanp-number-generator
 ```javascript
 import { generateNANPNumber } from "nanp-number-generator";
 
-const number = generateNANPNumber();
+const number = generateNANPNumber({});
 
 function show() {
   console.log(number);
 }
 
 show();
 ```
+
+## Options
+
+The `generateNANPNumber` function can take an object as its argument. The object can have the following properties:
+
+- `areaCode`: A string of 3 digits
+- `exchangeCode`: A string of 3 digits
+- `lineNumber`: A string of 4 digits
+
+The area code, exchange code, and line number will be validated before being returned. If any of the above properties are invalid according to the NANP, they will be replaced with a random valid number. Useful for keeping the area code the same, but generating a random exchange code and line number.
+
+### Example usage
+
+```javascript
+const number = generateNANPNumber({
+ areaCode: "503",
+ exchangeCode: "459",
+ lineNumber: "2769",
+});
+
+// returns "5034592769"
+```
+
+Alternatively, passing `true` into the function will generate a random TV number (555-XXXX format).
+
+### Example usage
+
+```javascript
+const number = generateNANPNumber(true);
+
+// returns a number in the format "NXX55501XX"
+```
+
+## License
+
+MIT
+
+## Author
+
+[KirbyPaint](https://github.com/KirbyPaint)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nanp-number-generator",
-  "version": "1.2.01",
+  "version": "1.2.02",
   "files": [
     "lib/**/*",
     "src/**/*"
@@ -40,16 +40,16 @@
     "test:coverage": "vitest run --coverage"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.0",
-    "@typescript-eslint/parser": "^5.59.0",
-    "@vitest/coverage-v8": "^0.32.0",
-    "eslint": "8.42.0",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "@vitest/coverage-v8": "^0.32.2",
+    "eslint": "^8.43.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "jsdom": "^22.0.0",
     "tsconfig-paths": "4.2.0",
-    "tsup": "^6.7.0",
-    "typescript": "5.1.3",
-    "vitest": "^0.32.0"
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "vitest": "^0.32.2"
   },
   "homepage": "https://github.com/KirbyPaint/nanp-number-generator#readme",
   "lint-staged": {