Update README.md

fcrepo4-archive · Feb 22, 2013 · e5a1364 · e5a1364
1 parent 23fda7c
commit e5a1364
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -62,6 +62,12 @@ An example of a fcrepo4 [Sequencer](https://docs.jboss.org/author/display/MODE/S
   a) Modeshape's `Sequencer` is presently an abstract class (rather than an interface), and 
   b) because jrubyc-generated Java classes extend `org.jruby.RubyObject`, so from ModeShape's 
   perspective, your JRuby class isn't a `Sequencer`.
+
+  It is, at least, mostly boilerplate. In the above, you should only need to change
+
+  1. the name of the proxy class (e.g. `MySequencerProxy`)
+  2. the filename (e.g. `my_sequencer`)
+  3. the instantiation of your Ruby class (e.g. `"MySequencer.new"`
 
 ### Testing and building