From 7897f8a72a78a2dac53eeeb11e5de4ebddeb1dad Mon Sep 17 00:00:00 2001 From: apainintheneck Date: Sat, 18 Nov 2023 19:26:11 -0800 Subject: [PATCH 1/3] Update readme --- README.md | 4 ++-- bin/generate_readme | 2 +- lib/atlasq/command/help.rb | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0a7a7cc..60a8cbc 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ OPTIONS : Search for countries by the following criteria 1. country (like --country) 2. region (like --region) - 3. currency (like --currency) + 3. currency (like --money) -c/--country : Display all countries @@ -198,7 +198,7 @@ $ atlasq --money Surinamese\ Dollar After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). +To install this gem onto your local machine, run `bundle exec rake install`. ## Contributing diff --git a/bin/generate_readme b/bin/generate_readme index 925679b..9be3cac 100755 --- a/bin/generate_readme +++ b/bin/generate_readme @@ -75,7 +75,7 @@ puts <<~README After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). + To install this gem onto your local machine, run `bundle exec rake install`. ## Contributing diff --git a/lib/atlasq/command/help.rb b/lib/atlasq/command/help.rb index 600f7ad..89fc09d 100644 --- a/lib/atlasq/command/help.rb +++ b/lib/atlasq/command/help.rb @@ -31,7 +31,7 @@ def content : Search for countries by the following criteria 1. country (like --country) 2. region (like --region) - 3. currency (like --currency) + 3. currency (like --money) -c/--country : Display all countries From e284f82e609723e113eb2e4d0a82937821026354 Mon Sep 17 00:00:00 2001 From: apainintheneck Date: Sat, 18 Nov 2023 19:36:04 -0800 Subject: [PATCH 2/3] Add more dev commands to readme --- README.md | 6 +++++- bin/generate_readme | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60a8cbc..2b316ca 100644 --- a/README.md +++ b/README.md @@ -196,10 +196,14 @@ $ atlasq --money Surinamese\ Dollar ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Use either `rake lint` to lint the code or `rake fix` to automatically fix simple linter errors. + +You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. +This file gets generated with the `rake readme:generate` command to make sure the example output is always up-to-date. We even check for this on CI with the `rake readme:outdated` command. + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/apainintheneck/atlasq. diff --git a/bin/generate_readme b/bin/generate_readme index 9be3cac..2f34653 100755 --- a/bin/generate_readme +++ b/bin/generate_readme @@ -73,10 +73,14 @@ puts <<~README ## Development - After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Use either `rake lint` to lint the code or `rake fix` to automatically fix simple linter errors. + + You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. + This file gets generated with the `rake readme:generate` command to make sure the example output is always up-to-date. We even check for this on CI with the `rake readme:outdated` command. + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/apainintheneck/atlasq. From 449da860dce26b9a65dfe0b93989d9a3581c804d Mon Sep 17 00:00:00 2001 From: apainintheneck Date: Sat, 18 Nov 2023 20:04:12 -0800 Subject: [PATCH 3/3] Add data source info to readme --- README.md | 8 ++++++++ bin/generate_readme | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/README.md b/README.md index 2b316ca..f0eb037 100644 --- a/README.md +++ b/README.md @@ -194,6 +194,14 @@ $ atlasq --money Surinamese\ Dollar ``` +## Data + +Country data is sourced from the [countries](https://github.com/countries/countries) gem which provides country and region information and implements the ISO3166 standard country codes and names. + +Currency data is sourced from from the [money](https://github.com/RubyMoney/money) and [money-heuristics](https://github.com/RubyMoney/money-heuristics) gems which provide information about currency names and symbols. + +Language data is sourced from the [ISO-639](https://github.com/xwmx/iso-639) gem which implements the ISO369 standard for language codes and names. + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Use either `rake lint` to lint the code or `rake fix` to automatically fix simple linter errors. diff --git a/bin/generate_readme b/bin/generate_readme index 2f34653..f454834 100755 --- a/bin/generate_readme +++ b/bin/generate_readme @@ -71,6 +71,14 @@ puts <<~README #{atlasq "--money", "Surinamese Dollar"} ``` + ## Data + + Country data is sourced from the [countries](https://github.com/countries/countries) gem which provides country and region information and implements the ISO3166 standard country codes and names. + + Currency data is sourced from from the [money](https://github.com/RubyMoney/money) and [money-heuristics](https://github.com/RubyMoney/money-heuristics) gems which provide information about currency names and symbols. + + Language data is sourced from the [ISO-639](https://github.com/xwmx/iso-639) gem which implements the ISO369 standard for language codes and names. + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Use either `rake lint` to lint the code or `rake fix` to automatically fix simple linter errors.