Skip to content

Commit

Permalink
Merge pull request #77 from danieldupriest/readme-instructions-to-sup…
Browse files Browse the repository at this point in the history
…press-data-download

Added instructions for suppressing data download
  • Loading branch information
tomayac authored Jul 18, 2023
2 parents 1d52b85 + 90338dd commit 7b5b743
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ geocoder.init({}, function () {

Optionally `init()` also allows you to specify which files to load data from.
This reduces initialization time and the runtime memory footprint of the Node.js
process. By default all files are loaded.
process. By default, all files are loaded.

```javascript
var geocoder = require('local-reverse-geocoder');
Expand Down Expand Up @@ -381,9 +381,11 @@ npm install local-reverse-geocoder
## A Word on Data Freshness

By default, the local [GeoNames dump](http://download.geonames.org/export/dump/)
data gets refreshed each day. You can override this behavior by removing the
timestamp from the files in the `./geonames_dump` download folder. If you don't
need admin1, admin2, admin3, admin4 or alternate names you can turn them off in
data gets refreshed each day, creating files such as
`admin1CodesASCII_YYYY-MM-DD.txt` in the cache directory. If you wish to reuse
the existing downloaded files, you can rename them to remove the date, such as
`admin1CodesASCII.txt`, which will suppress the download. If you don't
need admin1, admin2, admin3, admin4 or alternate names, you can turn them off in
a manual init call and decrease load time.

## A Word on Memory Usage
Expand Down

0 comments on commit 7b5b743

Please sign in to comment.