README.md in usps-ruby-client-0.1.1 vs README.md in usps-ruby-client-0.1.2
- old
+ new
@@ -4,11 +4,11 @@
[](https://codeclimate.com/github/joeyparis/usps-ruby-client/maintainability)
[](https://codeclimate.com/github/joeyparis/usps-ruby-client/test_coverage)
An unofficial Ruby client for The United Sates Postal Service Web Tools API.
-**Disclaimer** This gem is mostly auto-generated from the [USPS API User Guides](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). Because of inconsistencies and innacurracies in the user guides some end points may not work as expected, or may not be consistent with other methods in this gem.
+**Disclaimer** This gem is mostly auto-generated from the [USPS API User Guides](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). Because of inconsistencies and inaccuracies in the user guides, some endpoints may not work as expected or may not be consistent with other methods in this gem.
## Installation
Add this line to your application's Gemfile:
@@ -50,28 +50,33 @@
}
}
}
```
+## RubyDoc Automatic Documentation
+The generator also creates [documentation](https://rubydoc.info/gems/usps-ruby-client) to help you navigate the available methods. It has the same issues presented in the disclaimer above.
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
### Updating the auto-generated methods
-Because the USPS website does not allow scripts to make requests against their website you must [download the API User Guide HTML files manually](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). I recommend right-clicking the **HTM** and selecting *Save Link As...* to prevent any browser extensions from injecting their code and breaking the parsing.
+Because the USPS website does not allow scripts to make requests against their website, you must [download the API User Guide HTML files manually](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). I recommend right-clicking the **HTM** link and selecting *Save Link As...* to prevent any browser extensions from injecting their code and breaking the parsing.
-Place just the `.htm` files in `lib/data/api` (and remove any they may no longer be active) and run `rake usps:api:update`. This task will recreate all the relevant methods and some basic spec tests.
+Place just the `.htm` files in `lib/data/api` (and remove any that may no longer be active) and run `rake usps:api:update`. This task will recreate all the appropriate methods and some basic spec tests.
+We might be able to automate this with a headless browser tool like Watir, but only if we can do that in a way that doesn't bloat the gem as a whole.
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/joeyparis/usps-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joeyparis/usps-ruby-client/blob/master/CODE_OF_CONDUCT.md).
-This is still an early work-in-progress so any additional help is definitely appreciated!
+This project is still an early work-in-progress, so any additional help is greatly appreciated!
## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
-Everyone interacting in the Usps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeyparis/usps-ruby-client/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Usps project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/joeyparis/usps-ruby-client/blob/master/CODE_OF_CONDUCT.md).