README.md in lti_provider_engine-0.0.4 vs README.md in lti_provider_engine-0.0.5

- old
+ new

@@ -5,23 +5,23 @@ ## Installation Add the gem to your `Gemfile` with the following line, and then `bundle install` -``` +```ruby gem 'lti_provider_engine', :require => 'lti_provider' ``` Then, mount the engine to your app by adding this line to your `routes.rb` file -``` +```ruby mount LtiProvider::Engine => "/" ``` Next, include the engine in your `ApplicationController` -``` +```ruby class ApplicationController < ActionController::Base include LtiProvider::LtiApplication ... end @@ -30,11 +30,11 @@ After that, create `lti.yml` and `lti_xml.yml` files in your `config/` folder that looks something like this: **lti.yml** -``` +```yml default: &default key: your_key secret: your_secret require_canvas: true @@ -51,11 +51,11 @@ You'll need the values of `key` and `secret` when you configure your lti app on the tool consumer side. **lti_xml.yml** -``` +```yml default: &default tool_title: 'Dummy App' tool_description: 'A very handy dummy application for testing LtiProvider engine integration.' tool_id: 'dummy' privacy_level: 'public' @@ -78,11 +78,11 @@ These values are used in the `/configure.xml` endpoint. Finally, run migrations: -``` +```bash bundle install bundle exec rake railties:install:migrations bundle exec rake db:migrate ``` @@ -114,9 +114,10 @@ * `current_course_id` * `tool_consumer_instance_guid` * `current_account_id` * `course_launch?` * `account_launch?` + * `user_roles` ## Configuring the Tool Consumer You will need `key` and `secret` from your `lti.yml` file, and you can find configuration xml (or at least a starting point) at