Skip to content

Commit

Permalink
Add a deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
markogresak committed Aug 18, 2020
1 parent 2570a7f commit ed3d6b0
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
# [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

> Get public IP using [canihazip.com](http://canihazip.com/).
### :warning: Deprecation notice

The [canihazip.com](http://canihazip.com/) project stopped working. See the report at #2. As a fallback, this project is using [ipify.org](https://www.ipify.org/) with [patch 1.0.3](https://github.com/markogresak/canihazip/releases/tag/v1.0.3) so it does not break old usages.

**For new projects, I suggest using [`public-ip`](https://www.npmjs.com/package/public-ip)**. It is better maintained, built to be more robust (to avoid issues like #2) and has a better feature set.

---

> Get public IP using ~~[canihazip.com](http://canihazip.com/)~~ [ipify.org](https://www.ipify.org/).
## Install

Expand Down Expand Up @@ -39,7 +46,6 @@ This will return IP of the current machine, for example: `1.2.3.4`.

MIT © [Marko Grešak](https://gresak.io)


[npm-image]: https://badge.fury.io/js/canihazip.svg
[npm-url]: https://npmjs.org/package/canihazip
[travis-image]: https://travis-ci.org/markogresak/canihazip.svg?branch=master
Expand Down

0 comments on commit ed3d6b0

Please sign in to comment.