README.markdown

   1 StringRay
   2 =========
   3
   4 **StringRay** exposes a powerful method to split a `String` into an `Array` of
   5 words, and further allows you to include `Enumerable`, thus exposing many of the most useful `Array` methods on your `String`s.
   6
   7 Links
   8 -----
   9
  10 * [source (GitHub)](http://github.com/elliottcable/stringray "GitHub source repository")
  11 * [wiki (Google Code)](http://code.google.com/p/stringray/w/list "Google Code wiki")
  12 * [issues (Google Code)](http://code.google.com/p/stringray/issues "Google Code issues")
  13 * [Gitorious mirror](http://gitorious.org/projects/stringray "Gitorious source repository")
  14 * [RubyForge mirror](http://rubyforge.org/projects/stringray/ "RubyForge project")
  15 * [repo.or.cz mirror](http://repo.or.cz/w/stringray.git "repo.or.cz source repository")
  16
  17
  18 Usage
  19 -----
  20
  21     class String; include StringRay; end
  22
  23     "Oi! I'm a string, do something fun with me!".enumerate do |word|
  24       p word
  25     end
  26
  27     class String; make_enumerable!; end
  28     "Who, what, when, where, why? The questions these are.".map do |word|
  29       word << word[0].chr
  30     end
  31
  32 Getting
  33 -------
  34
  35 The authoritative source for this project is available at
  36 <http://github.com/elliottcable/stringray>. You can clone your own copy with
  37 the following command:
  38
  39     git clone git://github.com/elliottcable/stringray.git
  40
  41 If you want to make changes to the codebase, you need to fork your own GitHub
  42 repository for said changes. Send a pullrequest to [elliottcable](http://github.com/elliottcable "elliottcable on GitHub")
  43 when you've got something ready for the master branch that you think should be
  44 merged.
  45
  46 Requirements
  47 ------------
  48
  49 To use StringRay, you need... nothing!
  50
  51 Contributing
  52 ------------
  53
  54 To develop and contribute to StringRay, you need...
  55
  56 * `gem install rake`
  57 * `gem install rspec`
  58 * `gem install rcov`
  59 * `gem install echoe`