h1. Ruby and Rails Rules Engine Framework

h4. More detailed documentation at "www.r3ef.com":http://www.r3ef.com

h2. Templates

h3. Plan Start

Run a new plan and pass on the current data

<pre>
script/rails generate rules_engine_templates:rule plan_start [rule name]
</pre>

h3. Workflow Start

Start a workflow

<pre>
script/rails generate rules_engine_templates:rule workflow_start [rule name]
</pre>

h3. Workflow Stop

Stop the workflow and plan

<pre>
script/rails generate rules_engine_templates:rule workflow_stop [rule name]
</pre>


h3. Twitter Reader

Search twitter for responses

<pre>
script/rails generate rules_engine_templates:rule tweet_reader [rule name]
rake db:migrate
</pre>

h3. Twitter Filter

Filter twitter messages

<pre>
script/rails generate rules_engine_templates:rule tweet_filter [rule name]
</pre>

h3. Twitter Filter Retweets

Filter twitter retweets

<pre>
script/rails generate rules_engine_templates:rule tweet_filter_rt [rule name]
</pre>

h3. Twitter Word Splitter

Split the twitter message into individual words for processing

<pre>
script/rails generate rules_engine_templates:rule tweet_word_splitter [rule name]
</pre>

h3. Twitter Word Filter

Filter out twitter messages with matching words

<pre>
script/rails generate rules_engine_templates:rule tweet_word_filter [rule name]
</pre>


h3. Twitter Word Writer

Write the words to the database for processing

<pre>
script/rails generate rules_engine_templates:rule tweet_word_writer [rule name]
rake db:migrate
</pre>