README.md in works_cited-0.1.14 vs README.md in works_cited-0.1.15

- old
+ new

@@ -1,12 +1,10 @@ # Works Cited Works Cited allows you to add a list of the works cited in ActiveRecord objects, to be formatted by a helper that can be added to relevant pages to format the citations like a bibliography. Works Cited uses CanCanCan to authorize the editing of citations. This makes it easy for you to control access. -Works Cited is compatible with, but does not require, Rails Admin. - ## Installation Add this line to your application's Gemfile: ```ruby gem 'works_cited' @@ -81,9 +79,36 @@ Add the helpers to the relevant views ```haml = works_cited_list @record +``` + +To add routes so that you can edit citations on their own pages: + +```ruby + mount WorksCited::Engine => '/works_cited' +``` + +To add the fields, nested inside your forms + +```haml += form_for(@doodad) do |f| + = works_cited_citations_fields f +``` + +Don't forget to add the controller concern to enable nested attributes with strong parameters + +```ruby +class RecipesController < ApplicationController + include Cookbook::Params + + #... + + def recipe_params + params.require(:doodad).permit(:name, :description, works_cited_params) + end +end ``` ## Contributing * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it. \ No newline at end of file