Skip to content

Commit bb68c0e

Browse files
committed
update README.
1 parent f0ce914 commit bb68c0e

File tree

2 files changed

+31
-19
lines changed

2 files changed

+31
-19
lines changed

LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 iqhater
3+
Copyright (c) 2018-current iqhater
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

+29-17
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,44 @@
88
</a>
99
</div>
1010

11-
## How To Install
11+
`myip` is a simple and convenient CLI tool for retrieving your local and external IP address.
1212

13-
```
14-
go get github.com\iqhater\myip
15-
```
13+
## 🚀 Installation
1614

17-
Add to your system PATH for convenience to run "myip" at anywhere
15+
Install `myip` using `go install`:
1816

17+
```sh
18+
go install github.com/iqhater/myip@latest
1919
```
20-
export PATH=:~\github.com\iqhater\myip
20+
21+
Then, add it to your `PATH` if necessary:
22+
23+
```sh
24+
export PATH=$HOME/go/bin:$PATH
2125
```
2226

23-
## How to Use
27+
## 🛠 Usage
2428

25-
Type "myip" at your CLI.
29+
Simply run the command:
2630

31+
```sh
32+
myip
2733
```
28-
:~$ myip
29-
Interface Name: vEthernet (hyperV-external)
30-
Internal IP: 10.180.0.60
31-
External IP: 42.30.210.106
32-
Country: Netherlands
33-
Country Code: NL
34-
Region: Groningen
34+
35+
You will get the following output:
36+
37+
```sh
38+
Local interface name: vEthernet (hyperV-external)
39+
Internal IP (IPv4): 10.180.0.60
40+
External IP (IPv4): 42.30.210.106
41+
Country: Netherlands
42+
Country Code: NL
3543
```
3644

37-
## License
45+
## 📜 License
46+
47+
This project is licensed under the [MIT License](LICENSE).
48+
49+
---
3850

39-
[MIT License](LICENSE)
51+
💡 *Star us on GitHub if you like this project!*

0 commit comments

Comments
 (0)