Skip to content

Commit

Permalink
Draft update of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
christiantakle committed Jun 11, 2014
1 parent 3a190ff commit 2df6080
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,20 @@ And remember to `bundle`

## Usage

This gem adds `String#embedda` to Ruby strings. You use it like this:
If you want to extend Ruby `String#embedda` add the following.

```ruby
require 'embedda'

class String
def embedda(options = {})
Embedda.new(self, options).embed
end
end
```

Its best practice not to extend core objects and use the Embedda class itself.
Examples are written with the `String` extended. You use it like this:

```ruby
"String heheh http://www.youtube.com/watch?v=BVtYSy83XXw yeah".embedda
Expand Down

0 comments on commit 2df6080

Please sign in to comment.