https://github.com/sgerrand/humaans.rb
Ruby HTTP client for the Humaans API
https://github.com/sgerrand/humaans.rb
api-client gems humaans ruby-gem
Last synced: 3 months ago
JSON representation
Ruby HTTP client for the Humaans API
- Host: GitHub
- URL: https://github.com/sgerrand/humaans.rb
- Owner: sgerrand
- License: mit
- Created: 2023-05-26T11:43:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-26T11:45:19.000Z (almost 2 years ago)
- Last Synced: 2025-01-30T19:19:05.543Z (4 months ago)
- Topics: api-client, gems, humaans, ruby-gem
- Language: Ruby
- Homepage: https://rubygems.org/gems/humaans
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Humaans
A Ruby client library for the [Humaans API](https://docs.humaans.io/api/).
## Requirements
* Ruby >= 2.6
## Installation
Install the gem and add to the application's Gemfile by executing:
bundle add humaans
If bundler is not being used to manage dependencies, install the gem by executing:
gem install humaans
You won't need the source code unless you want to modify the gem.
## Usage
TODO: Write usage instructions here
## 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.
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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sgerrand/humaans.rb. 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/sgerrand/humaans.rb/blob/main/CODE_OF_CONDUCT.md).
## License
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 Humaans project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sgerrand/humaans.rb/blob/main/CODE_OF_CONDUCT.md).