README.markdown

   1 StringRay
   2 =========
   3 **StringRay** exposes a powerful method to split a `String` into an `Array` of
   4 words, and further allows you to include `Enumerable`, thus exposing many of the most useful `Array` methods on your `String`s.
   5
   6 Links
   7 -----
   8 - [Source code (GitHub)](
   9     http://github.com/elliottcable/stringray "GitHub source repository")
  10 - [Issues and suggestions (GitHub)](
  11     http://github.com/elliottcable/stringray/issues "GitHub issues")
  12
  13 Usage
  14 -----
  15 Basic usage is really simple. Just take a normal `String` (the `StringRay`
  16 magic has already been included for you) and enumerate over it, just as you
  17 are used to doing with `Array`s. By default, this enumerates over the "words"
  18 in the string.
  19
  20     "Oi! I'm a string, do something fun with me!".enumerate do |word|
  21       p word
  22     end
  23
  24     "Who, what, when, where, why? The questions these are.".map do |word|
  25       word << word[0]
  26     end
  27
  28 You can gain a *lot* more fine-grained control over how the string is treated
  29 by passing arguments to the enumerator methods, or by explicitly creating a
  30 `StringRay` enumerator and modifying it.
  31
  32     TODO: More examples and usage summaries!
  33
  34 Getting
  35 -------
  36 The authoritative source for this project is available at
  37 <http://github.com/elliottcable/stringray>. You can clone your own copy with
  38 the following command:
  39
  40     git clone git://github.com/elliottcable/stringray.git
  41
  42 If you want to make changes to the codebase, you need to fork your own GitHub
  43 repository for said changes. Send a pullrequest to [elliottcable][] when
  44 you've got something ready for the master branch that you think should be
  45 merged.
  46
  47   [elliottcable]: http://github.com/elliottcable
  48     "elliottcable's profile on GitHub"
  49
  50 Requirements
  51 ------------
  52 To use StringRay, you need... nothing!
  53
  54 Contributing
  55 ------------
  56 To develop and contribute to StringRay, you need...
  57
  58 - `gem install rake`
  59 - `gem install echoe`
  60 - `gem install rspec`
  61 - `gem install relevance-rcov`
  62 - `gem install yard`
  63
  64 Mirrors
  65 -------
  66 If GitHub is unavailable, or you prefer to fork one one of the following
  67 sources, they are also available:
  68
  69 - [Gitorious mirror](http://gitorious.org/projects/stringray
  70     "Gitorious source repository")
  71 - [RubyForge mirror](http://rubyforge.org/projects/stringray/
  72     "RubyForge project")
  73 - [repo.or.cz mirror](http://repo.or.cz/w/stringray.git
  74     "repo.or.cz source repository")