Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.26 KB

README.textile

File metadata and controls

47 lines (31 loc) · 1.26 KB
Raw

Crocodoc

A complete Ruby interface to the fantastic Crocodoc document embedding/conversion service.

Design/Features

There is another Ruby interface to Crocodoc, crocodoc-ruby, and it’s only partially functional. Its implementation does not offer a proper object-oriented interface, and only supports basic Net::HTTP requests.

With this gem, I aim to provide the following functionality:

  • A document-oriented interface. You perform operations on Document objects, which are serializable for easier database integration.
  • A helper for generation of viewing sessions.
  • Use of Faraday, allowing you to use whichever HTTP backend best suits your purposes.
  • Webhook helpers
  • System monitoring checks

Installation

Add this line to your application’s Gemfile:

gem 'crocodoc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install crocodoc

Usage

See the examples directory for examples.

Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am ‘Added some feature’`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request