Skip to content

Commit

Permalink
Minor comments clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
fvdm committed Apr 23, 2016
1 parent a423b6d commit 8e5dd74
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 10 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Unofficial Node.js module for the Maxmind GeoIP2 Web Services.
Usage
-----

There are multiple ways to load and set up this module. All communication is done over HTTPS.
There are multiple ways to load and set up this module.
All communication is done over HTTPS.

#### One line

Expand Down Expand Up @@ -48,8 +49,9 @@ country (ip, callback);
Installation
------------

You need a Maxmind account ID and license key with enough credits for one of their GeoIP *web*
services. You can find both [*here*](https://www.maxmind.com/en/my_license_key).
You need a Maxmind account ID and license key with enough credits
for one of their GeoIP *web* services.
You can find both [*here*](https://www.maxmind.com/en/my_license_key).

`npm install geoip2ws`

Expand Down Expand Up @@ -110,7 +112,7 @@ function myCallback (err, data) {
}
```

Response data: <http://dev.maxmind.com/geoip/geoip2/web-services/#Response_Body>
[Example response data](http://dev.maxmind.com/geoip/geoip2/web-services/#Response_Body)


#### Errors
Expand All @@ -124,7 +126,7 @@ request failed | A request error occured | `err.error`
API error | API error occured | `err.code` and `err.error`


API errors: <http://dev.maxmind.com/geoip/geoip2/web-services/#Errors>
[List of API errors](http://dev.maxmind.com/geoip/geoip2/web-services/#Errors)


Unlicense
Expand Down Expand Up @@ -159,6 +161,4 @@ For more information, please refer to <http://unlicense.org/>
Author
------

Franklin van de Meent
| [Website](https://frankl.in/)
| [Github](https://github.com/fvdm)
[Franklin van de Meent](https://frankl.in/)
3 changes: 2 additions & 1 deletion geoip2ws.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/*
Name: geoip2ws
Description: Maxmind GeoIP2 Web Services for node.js
Author: Franklin van de Meent (https://frankl.in)
Source & docs: https://github.com/fvdm/nodejs-geoip2ws
Feedback: https://github.com/fvdm/nodejs-geoip2ws/issues
License: Unlicense (public domain)
Expand Down Expand Up @@ -108,7 +109,7 @@ function doLookup (serviceName, ip, callback) {
httpProps.timeout = api.requestTimeout;
httpProps.headers = {
'Accept': 'application/vnd.maxmind.com-' + serviceName + '+json; charset=UTF-8; version=2.1',
'User-Agent': 'geoip2ws.js'
'User-Agent': 'geoip2ws.js (https://github.com/fvdm/nodejs-geoip2ws)'
};

http.doRequest (httpProps, function doRequest (err, res) {
Expand Down
3 changes: 2 additions & 1 deletion test.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
/*
Name: geoip2ws - test.js
Description: Maxmind GeoIP2 Web Services for node.js
Author: Franklin van de Meent (https://frankl.in)
Source & docs: https://github.com/fvdm/nodejs-geoip2ws
Feedback: https://github.com/fvdm/nodejs-geoip2ws/issues
License: Unlicense (public domain)
License: Unlicense (public domain, see LICENSE file)
*/

var doTest = require ('dotest');
Expand Down

0 comments on commit 8e5dd74

Please sign in to comment.