README.md in bamboozled-0.2.0 vs README.md in bamboozled-0.3.0
- old
+ new
@@ -134,10 +134,35 @@
```ruby
# Find a report by its number
client.report.find(report_number, format = "JSON", fd = true)
```
+### Applicant Tracking System
+The ATS API is currently in **beta**. Please note that BambooHR may make breaking changes without
+warning. Refer to the [documentation](https://www.bamboohr.com/api/documentation/ats.php) for
+details.
+
+```ruby
+# Get a list of job summaries
+client.applicant_tracking.job_summaries
+
+# Get a list of applications, following pagination
+client.applicant_tracking.applications(page_limit: 10)
+
+# Get the details of an application
+client.applicant_tracking.application(123)
+
+# Add comments to an application
+client.applicant_tracking.add_comment(123, "Great Application!")
+
+# Get a list of statuses for a company
+client.applicant_tracking.statuses
+
+# Change applicant's status
+client.applicant_tracking.change_status(123, 3)
+```
+
### Metadata
```ruby
# Get fields
client.meta.fields
@@ -155,9 +180,14 @@
Thank you for contributing! We always welcome bug reports and/or pull requests.
Please take the time to go through our [contribution guidelines](CONTRIBUTING.md).
Special thanks to all the awesome people who have helped make this gem better.
You can see a list of them [here](https://github.com/Skookum/bamboozled/graphs/contributors).
+
+#### Deploying to rubygems
+1. Update the version in the `lib/bamboozled/version.rb` file
+2. Update specs to use that version
+3. In github, add a [release](https://github.com/Skookum/bamboozled/releases) off the master branch. This will trigger the github action to deploy to rubygems
## License
This project is licensed under the terms of the MIT license. See the
[LICENSE](/LICENSE) file.