Skip to content

Commit 1309164

Browse files
committed
Update README to remove stale rake task references
Replace references to old rake tasks with the unified free_zipcode_data executable and update Ruby version to 3.4+.
1 parent 0586a29 commit 1309164

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ This project is an automated solution for retrieving and collating US and worldw
66

77
## History
88

9-
In 2011, we originally pulled down all the US census data we could find, parsed it and exported it into 3 .csv files. Later, we wrote 3 rake tasks to automate this process.
9+
In 2011, we originally pulled down all the US census data we could find, parsed it and exported it into 3 .csv files.
1010

1111
In 2017 we began using [GeoNames](http://www.geonames.org) data, which is licensed under Creative Commons. We are grateful to [GeoNames](http://www.geonames.org) for sharing, and urge you to [visit their site](http://www.geonames.org) and support their work.
1212

13-
In 2018 we refactored the project and made it into a Ruby gem with a command-line executable for automating this process.
13+
In 2018 we refactored the project and made it into a Ruby gem with a unified command-line executable (`free_zipcode_data`) that handles downloading, processing, and database generation in a single step.
1414

1515
## What's Included
1616

@@ -22,7 +22,7 @@ See the GeoNames [readme.txt](http://download.geonames.org/export/zip/readme.txt
2222

2323
## Usage
2424

25-
First, you need to install Ruby and Rubygems. Though that is not a difficult task, it is beyond the scope of this README. A search engine of your choice will help discover how to do this. Once you have done that:
25+
First, you need to install Ruby 3.4+ and Rubygems. Though that is not a difficult task, it is beyond the scope of this README. A search engine of your choice will help discover how to do this. Once you have done that:
2626

2727
```bash
2828
$ gem install free_zipcode_data
@@ -61,8 +61,6 @@ $ free_zipcode_data --work-dir /tmp/work_dir --country US --generate-files
6161
$ free_zipcode_data --work-dir /tmp/work_dir --generate-files
6262
```
6363
64-
The rake tasks cascade, from the bottom up. So if you run `rake data:populate_db`, it will automatically call `rake data:build` if the .csv files are missing, which will call `rake data:download` if the .zip files are missing.
65-
6664
## SQLite3 Database
6765
6866
The executable will generate an SQLite3 database in the specified directory `--work-dir` but it will not generate the `.csv` files by default. Specify `--generate-files` if you want those as well.

0 commit comments

Comments
 (0)