@arnabxd/bin-lookup - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@arnabxd/bin-lookup",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Search bin details from various bin database",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

 # BIN-LOOKUP
 
-> Search bin details from various bin database
+> Search bin details from various bin database
+
+### Available Sources
+
+- bins.ws
+- binov.net
+
+### Installation
+
+```bash
+npm i @arnabxd/bin-lookup
+```
+
+or
+
+```bash
+yarn add @arnabxd/bin-lookup
+```
+
+### Example
+
+```ts
+import { binLookup } from '@arnabxd/bin-lookup';
+// or
+const { binLookup } = require('@arnabxd/bin-lookup');
+```
+
+```ts
+// using async await
+let bindata = await binLookup(439129, 'binov.net');
+console.log(bindata);
+
+// or using callbacks
+binLookup(439129).then((data)=> console.log(data));
+```
+
+### API
+
+- binLookup
+  - `bin` : `number`
+  - `site` : `string` (Supported Websites. Default `bins.ws`)

tsconfig.json

@@ -12,3 +12,3 @@ {
   },
-  "include": ["src", "src/types.ts"]
+  "include": ["src"]
 }

No alert changes

Improved metrics

Total package byte prevSize

8980

increased by7.06%

Number of lines in readme file

43

increased by1333.33%

No dependency changes