From f19bf578a057f4a28781713f12909a35d3121494 Mon Sep 17 00:00:00 2001 From: Frank Denis Date: Thu, 27 Oct 2016 17:32:38 +0200 Subject: [PATCH] Update doc --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d0fb6d..f4b5a2b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # iptoasn-webservice -Web service to map IP addresses to AS information, using iptoasn.com + +Webservice to map IP addresses to AS information. + +This is the source code of the public API from [iptoasn.com](https://iptoasn.com). + +Requires [rust-nightly](https://www.rust-lang.org/). + +# Usage: + +```sh +$ curl https://api.iptoasn.com/v1/as/ip/ +``` +```json +{ + "announced": true, + "as_country_code": "US", + "as_description": "LEVEL3 - Level 3 Communications, Inc.", + "as_number": 3356, + "first_ip": "4.0.0.0", + "last_ip": "4.23.87.255" +} +```