Permalink
Browse files

Expand the README

  • Loading branch information...
jordelver committed Dec 1, 2011
1 parent 4104eb3 commit 3462d895abdd0802564fa9e141bffe259bd99552
Showing with 27 additions and 2 deletions.
  1. +27 −2 README
View
29 README
@@ -1,3 +1,28 @@
-USAGE
+CREATING A NEW NOODALL COMPONENT
-rails plugin new noodall-thing --full -Om https://raw.github.com/stengland/noodall-plugin-template/master/template.rb
+Instructions for extracting/creating a Noodall component gem
+
+SETUP
+Generate a new component/plugin template
+
+ rails plugin new noodall-component-<name> --full -Om https://raw.github.com/stengland/noodall-plugin-template/master/template.rb
+
+ This generates a Rails Engine and applies our customisations.
+
+
+PROCESS
+Copy/create models in app/models
+
+Copy/create views in app/views/admin/components and app/views/components
+
+Setup slots for the new component under: test/dummy/config/initializers/noodall.rb
+
+Add new slots to test/dummy/app/models/content_page.rb
+
+Add the new component slot to test/dummy/app/views/nodes/content_page.html.erb
+
+Add cucumber tests and/or unit tests
+
+Setup factories in /factories
+
+Fill in the *.gemspec file

0 comments on commit 3462d89

Please sign in to comment.