Skip to content

Latest commit

 

History

History
36 lines (18 loc) · 2.41 KB

README.md

File metadata and controls

36 lines (18 loc) · 2.41 KB

DatoCMS Ruby Client

Coverage Status Build Status Gem Version

CLI tool for DatoCMS (https://www.datocms.com).

How to integrate DatoCMS with Jekyll

Please head over the Jekyll section of our documentation to learn everything you need to get started.

How to integrate DatoCMS with Middleman

For Middleman we have created a nice Middleman extension called middleman-dato. Please visit the Middleman section of our documentation to learn everything you need to get started.

API Client

This gem also exposes an API client, useful ie. to import existing content in your DatoCMS administrative area. Read our documentation for detailed info.

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 tags, and push the .gem file to rubygems.org.

Updating the client when the API changes

The DatoCMS API provides an always up-to-date JSON Hyperschema: the code of this gem is generated automatically starting from the schema running rake regenerate.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/datocms/ruby-datocms-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.