Skip to content

Commit

Permalink
v3.3.3: Revert README
Browse files Browse the repository at this point in the history
  • Loading branch information
joeymalvinni committed Feb 9, 2021
1 parent 427b128 commit 496c06a
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
# **webrtc-ip**
💻 Gets a users public IP address in the browser.
<br>
<br>
<br>


### NOTICE:
This script no longer gets users private IP addresses, due to security concerns originating with the teams at Google and Apple, but reliably gets public ones. For more information, please read [this](https://bloggeek.me/psa-mdns-and-local-ice-candidates-are-coming/) great article that explains all you need to know.
<br>
<br>
<br>


### Disclaimer
This software is for educational purposes only. This software should not be used for illegal activity. The author is not responsible for its use.

<br>
<br>
<br>


---


<br>
<br>
<br>

### Getting Started
If you are using this in the browser, include the following script in the `<head>` part of your HTML to access the `getIPs()` function:
Expand All @@ -31,17 +23,14 @@ If you are using this in the browser, include the following script in the `<head
```

You now have access to the `getIPs()` function.

<br>
<br>


---



### Usage
<br>


```js
// Using Promises:
getIPs().then(data=>{
Expand Down

0 comments on commit 496c06a

Please sign in to comment.