README.rdoc in rahoulb-rujitsu-0.1.3 vs README.rdoc in rahoulb-rujitsu-0.1.4
- old
+ new
@@ -1,13 +1,26 @@
= rujitsu
-A Rails gem with various helper methods to smooth out your Ruby development.
+A ruby gem with various helper methods to smooth out your Ruby development.
== Install
gem install rahoulb-rujitsu --source http://gems.github.com
+== Including
+
+ require "rujitsu"
+ require "rujitsu/grammar"
+
+=== Rails
+
+To require in rails 2.2, add the following to your +environment.rb+ file.
+
+ config.gem "rahoulb-rujitsu", :lib => "rujitsu", :source => "http://gems.github.com"
+ config.gem "rahoulb-rujitsu", :lib => "rujitsu/grammar", :source => "http://gems.github.com"
+
+
== Usage
=== Generating random strings
The Fixnum class has a couple of extensions allowing you to generate random strings.
@@ -25,10 +38,16 @@
=== URL-friendly strings
The String class has an extension that strips out URL-unfriendly characters.
""$%hello!@ 123 there'".to_url # => "hello-123-there"
-
+
+
+=== Grammar
+
+So far the grammar library just adds the method +should_recieve+ for rspec assertions. Use it to find out what it does!
+
+
== Released under the MIT Licence
Copyright (c) 2008 Brightbox Systems Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: