Browse files

Update the README to document how the starter kit gets installed

  • Loading branch information...
1 parent e0d8658 commit da1eac98336bc3978ced4b8899c0c6033e062713 @rudyrigot rudyrigot committed Nov 13, 2013
Showing with 14 additions and 0 deletions.
  1. +14 −0 README.md
View
14 README.md
@@ -4,6 +4,20 @@ This is a blank Rails project that will connect to any [prismic.io](https://pris
repository. It uses the prismic.io Ruby developement kit, and provides few helpers
to use it with Rails.
+### How to start?
+
+If you haven't yet, install the latest versions of [Ruby](https://www.ruby-lang.org/en/downloads/), [Rails](http://rubyonrails.org/download) and [RubyGems](http://rubygems.org/pages/download).
+
+After forking and cloning the starter kit, it is immediately operational, so you can launch your `rails server` command. You may have to update your gems by running `bundle install`, but Rails will tell you about it if you must.
+
+The output of your `rails server` command tells you which URL to visit on your browser to see your brand new prismic.io Rails application.
+
+### Configuring
+
+By default, the starter kit uses the public API of the "Les Bonnes Choses" repository; its endpoint is `https://lesbonneschoses.prismic.io/api`. You may want to start by editing the `config/prismic.yml` file to make your Rails application points to your prismic.io repository.
+
+To get the OAuth configuration working, go to the Applications panel in your repository settings, and create an OAuth application to allow interactive sign-in. Just create a new application, fill the application name and the callback URL (localhost URLs are always authorized, so at development time you can omit to fill the Callback URL field), and copy/paste the clientId & clientSecret tokens into the `config/prismic.yml` file.
+
### Licence
This software is licensed under the Apache 2 license, quoted below.

0 comments on commit da1eac9

Please sign in to comment.