Comparing version
{ | ||
"name": "ipinfo", | ||
"version": "1.0.0", | ||
"version": "1.1.0", | ||
"description": "An http://ipinfo.io NodeJS wrapper.", | ||
@@ -18,4 +18,4 @@ "main": "lib/index.js", | ||
], | ||
"author": "Ionică Bizău <bizauionica@gmail.com>", | ||
"license": "MIT", | ||
"author": "Ionică Bizău <bizauionica@gmail.com> (http://ionicabizau.net)", | ||
"license": "KINDLY", | ||
"bugs": { | ||
@@ -32,2 +32,2 @@ "url": "https://github.com/IonicaBizau/node-ipinfo/issues" | ||
"devDependencies": {} | ||
} | ||
} |
@@ -1,11 +0,13 @@ | ||
ipinfo | ||
====== | ||
# ipinfo [![Support this project][donate-now]][paypal-donations] | ||
An http://ipinfo.io NodeJS wrapper. | ||
# Installation | ||
## Installation | ||
```sh | ||
$ npm install ipinfo | ||
$ npm i ipinfo | ||
``` | ||
# Example | ||
## Example | ||
```js | ||
@@ -31,24 +33,39 @@ // Dependencies | ||
# Documentation | ||
## `IpInfo(type, callback)` | ||
## Documentation | ||
### `IpInfo(type, callback)` | ||
Makes requests to the ipinfo.io resources. | ||
### Params | ||
#### Params | ||
- **String** `type`: An optional string parameter that can be: | ||
- An ip (e.g. `"8.8.8.8"`) | ||
- An ip and the a field (e.g. `"8.8.8.8/org"`) | ||
- **Function** `callback`: The callback function. | ||
# How to contribute | ||
1. File an issue in the repository, using the bug tracker, describing the | ||
contribution you'd like to make. This will help us to get you started on the | ||
right foot. | ||
2. Fork the project in your account and create a new branch: | ||
`your-great-feature`. | ||
3. Commit your changes in that branch. | ||
4. Open a pull request, and reference the initial issue in the pull request | ||
message. | ||
#### Return | ||
- **** | ||
# License | ||
See the [LICENSE](./LICENSE) file. | ||
## How to contribute | ||
Have an idea? Found a bug? See [how to contribute][contributing]. | ||
## Where is this library used? | ||
If you are using this library in one of your projects, add it in this list. :sparkles: | ||
- [`cli-sunset`](https://github.com/IonicaBizau/cli-sunset) | ||
- [`ipinfo-cli`](https://github.com/beatfreaker/ipinfo-cli) by Chintan Radia | ||
- [`sphere-ipinfo-mashup`](https://github.com/mmoelli/sphere-ipinfo-mashup) by Martin Möllmann | ||
## License | ||
[KINDLY][license] © [Ionică Bizău][website] | ||
[license]: http://ionicabizau.github.io/kindly-license/?author=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica@gmail.com%3E&year=2014 | ||
[website]: http://ionicabizau.net | ||
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW | ||
[donate-now]: http://i.imgur.com/6cMbHOC.png | ||
[contributing]: /CONTRIBUTING.md | ||
[docs]: /DOCUMENTATION.md |
Sorry, the diff of this file is not supported yet
Misc. License Issues
License(Experimental) A package's licensing information has fine-grained problems.
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.
Found 1 instance in 1 package
7698
73.81%7
16.67%70
29.63%1
Infinity%1
Infinity%80
-20%