File: README — Documentation for prismicio/ruby-kit (master)

Ruby development kit for prismic.io

Getting Started

The prismic kit is compatible with Ruby 1.9.3 or later.

Install the kit for your project

(Assuming that Ruby is installed on your computer, as well as RubyGems)

To install the gem on your computer, run in shell:

gem install prismic.io --pre

then add in your code:

require 'prismic'

To add the gem as a dependency to your project with Bundler, you can add this line in your Gemfile:

gem 'prismic.io', require: 'prismic'

Get started

The quickstart is not available for Ruby yet, but if you understand Javascript you can easily adapt the code.

Configuring Alternative API Caches

The default cache stores data in-memory, in the server. You may want to use a different cache, for example to share it between several servers (with memcached or similar). A null cache (does no caching) is also available if you need a predictible behavior for testing or VCR. To use it (or any other compliant cache), simply add api_cache: Prismic::BasicNullCache.new to the options passed to Prismic.api.

Changelog

Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.

Install the kit locally

Of course, you're going to need Ruby installed on your computer, as well as RubyGems and Bundler.

Clone the kit, then run bundle install.

Test

Please write tests for any bugfix or new feature, by placing your tests in the spec/ folder, following the RSpec syntax. Launch the tests by running rspec

If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Documentation

Please document any bugfix or new feature, using the Yard syntax. Don't worry about generating the doc, we'll take care of that.

If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.

Contributing

We hope you'll get involved! Read our Contributors' Guide for details.

Licence

This software is licensed under Apache 2.0 license