Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Aug 9, 2020
1 parent b49a074 commit f0d5b05
Show file tree
Hide file tree
Showing 4 changed files with 117 additions and 20 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014-19 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2014-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
131 changes: 114 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,52 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# ipinfo

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/ipinfo.svg)](https://www.npmjs.com/package/ipinfo) [![Downloads](https://img.shields.io/npm/dt/ipinfo.svg)](https://www.npmjs.com/package/ipinfo) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>







> An http://ipinfo.io NodeJS wrapper.
















## :cloud: Installation

```sh
Expand All @@ -20,6 +58,17 @@ yarn add ipinfo
```













## :clipboard: Example


Expand Down Expand Up @@ -62,17 +111,28 @@ ipInfo((err, cLoc) => {











## :question: Get Help

There are few ways to get help:



1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:





## :memo: Documentation


Expand All @@ -89,12 +149,22 @@ Makes requests to the ipinfo.io resources.














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].


## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).

Expand All @@ -113,35 +183,62 @@ However, if you get some profit from this or just want to encourage me to contin
Thanks! :heart:
















## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- `hapi-geo-locate`
- `auto-geo-sunset`
- `sphere-ipinfo-mashup`
- `sunset-year`
- `family_one`
- `@elasticlive/sdk`
- `alphaselfbot`
- `ipinfo-cli`
- `cli-sunset`
- `ionicabizau.net`
- `machine-ip`










- [`auto-geo-sunset`](https://github.com/aminnaggar/auto-geo-sunset#readme) (by Amin El-Naggar)—Automagically figures out your location using your ip, and uses that to calculate the time of sunset.
- [`cli-sunset`](https://github.com/IonicaBizau/cli-sunset)—A fancy command line tool for knowing the sunset time.
- [`family_one`](https://family.one/app)https://medium.com/@pshrmn/a-simple-react-router-v4-tutorial-7f23ff27adf
- [`hapi-geo-locate`](https://github.com/fs-opensource/hapi-geo-locate#readme) (by Future Studio)—Provide IP geo location for incoming requests in hapi
- [`ionicabizau.net`](https://github.com/IonicaBizau/ionicabizau.net#readme)—My blog
- [`ipinfo-cli`](https://github.com/beatfreaker/ipinfo-cli) (by Chintan Radia)—Get current ip information
- [`machine-ip`](https://github.com/IonicaBizau/machine-ip#readme)—Update your public ip information in a git repository.
- [`sphere-ipinfo-mashup`](https://github.com/mmoelli/sphere-ipinfo-mashup) (by Martin Möllmann)—Create carts in SPHERE.IO with information based on your IP address.
- [`sunset-year`](https://github.com/IonicaBizau/sunset-year#readme)—Sunset times during the year, every week.

## :scroll: License

[MIT][license] © [Ionică Bizău][website]






[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2014#license-mit
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit f0d5b05

Please sign in to comment.