-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Update README.md with more example
- Loading branch information
1 parent
af38e1f
commit 80306b7
Showing
1 changed file
with
51 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,51 @@ | ||
[this subtext](dist/README.md) | ||
[![npm version](https://badge.fury.io/js/domaindumper.svg)](https://badge.fury.io/js/domaindumper) | ||
[![Netlify Status](https://api.netlify.com/api/v1/badges/eadf929b-e093-4a1a-b449-9eb62242aff9/deploy-status)](https://app.netlify.com/sites/domaindumper/deploys) | ||
|
||
Domain Dumper daily states of domains | ||
|
||
An API that provides statistics for domains that are registered every day. Here you can get daily updates on how many domains are registered on each TLD. We update our files every 24 hours. | ||
|
||
## How to use | ||
|
||
### Package manager | ||
|
||
Using npm: | ||
|
||
```bash | ||
$ npm install domaindumper | ||
``` | ||
|
||
Using yarn: | ||
|
||
```bash | ||
$ yarn add domaindumper | ||
``` | ||
|
||
Once the package is installed, you can import the library using `import` or `require` approach: | ||
|
||
```js | ||
import domaindumper, {isCancel, domaindumperError} from 'domaindumper'; | ||
``` | ||
|
||
You can also use the default export, since the named export is just a re-export from the domaindumper factory: | ||
|
||
```js | ||
import domaindumper from 'domaindumper'; | ||
|
||
console.log(domaindumper.isCancel('something')); | ||
```` | ||
|
||
If you use `require` for importing, **only default export is available**: | ||
|
||
```js | ||
const domaindumper = require('domaindumper'); | ||
console.log(domaindumper.isCancel('something')); | ||
``` | ||
## More example | ||
|
||
All documentation moved to under this url: [https://statistics.domaindumper.com/](https://statistics.domaindumper.com/) | ||
|
||
## Need premium services | ||
|
||
if you need premium services like domains Whois OR Free daily registered domain names, then you can find this information on our other website: [https://www.whoisextractor.in/](https://www.whoisextractor.in/ "Whoisextractor") |