docs(readme): update readme and description

Jun711 · Mar 6, 2018 · b242637 · b242637
1 parent 932d614
commit b242637
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,16 @@ This script can detect user's location based on IPs
 and returns Amazon geotargeted URLs.
 
 ## Usage
+```javascript
+const amazonGeotargetService = new AmazonGeotargetService();
+amazonGeotargetService.amazonGeotarget().then(res => console.log(res));  
+
+// To use it with a 'www.amazon.co.uk' as the default store
+const amazonGeotargetService = new AmazonGeotargetService('www.amazon.co.uk');
+amazonGeotargetService.amazonGeotarget().then(res => console.log(res));
+```
 
+Refer to index.html for usage on a webpage.
 
 ## IP Sources
 IP service providers:

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "amazonGeotarget",
-  "version": "0.0.0-development",
-  "description": "It is to locate the location of a user",
+  "name": "amazon-geotarget",
+  "version": "1.0.0",
+  "description": "It detects users' location and returns the right amazon store url.",
   "main": "src/index.js",
   "scripts": {
     "coverage": "nyc report --reporter=text-lcov | coveralls",