README.md in easypost-4.8.1 vs README.md in easypost-4.9.0
- old
+ new
@@ -1,8 +1,9 @@
# EasyPost Ruby Client Library
[](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
+[](https://coveralls.io/github/EasyPost/easypost-ruby?branch=master)
[](https://badge.fury.io/rb/easypost)
EasyPost, the simple shipping solution. You can sign up for an account at <https://easypost.com>.
## Install
@@ -128,17 +129,20 @@
EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
# Run security analysis
make scan
+# Generate library documentation
+make docs
+
# Update submodules
git submodule init
git submodule update --remote
```
### Testing
-The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run.
+The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run. If you receive errors about a cassette expiring, delete and re-record the cassette to ensure the data is up-to-date.
**Sensitive Data:** We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.
**Making Changes:** If you make an addition to this project, the request/response will get recorded automatically for you. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.