README.md in seventeen_mon-0.0.2 vs README.md in seventeen_mon-0.0.3
- old
+ new
@@ -1,8 +1,8 @@
# SeventeenMon
-Simply find location by IP.
+SeventeenMon simply help you find location by IP address. Data is totally based on [17MON.CN](http://tool.17mon.cn/).
## Installation
Add this line to your application's Gemfile:
@@ -17,20 +17,38 @@
$ gem install seventeen_mon
## Usage
+### In Ruby
```(ruby)
-SeventeenMon.find_by_ip ip: "YOUR_IP_ADDRESS"
+SM.find_by_ip "YOUR_IP_ADDRESS"
# => {:country=>"英国", :city=>"英国"}
-SM.find_by_address address: "ruby-lang.com", protocol: "http"
+SM.find_by_address "http://ruby-lang.com"
# => {:country=>"荷兰", :city=>"荷兰"}
```
+### In Command Line
+
+```(bash)
+$ seventeen ip 188.74.78.234
+Country: 英国
+City: 英国
+
+
+$ seventeen address https://github.com
+Country: 美国
+City: 美国
+```
+
## Contributing
1. Fork it ( http://github.com/<my-github-username>/seventeen_mom/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Thanks
+
+[高春辉 Paul Gao](http://tool.17mon.cn/) - for his awesome data.
\ No newline at end of file