Permalink
Browse files

updated readme

  • Loading branch information...
1 parent 6ffbf71 commit 5e5df4f1008271099b5b0b0d20df36823c5bd8ba @audy committed Sep 30, 2012
Showing with 11 additions and 3 deletions.
  1. +11 −3 readme.md
View
14 readme.md
@@ -1,6 +1,6 @@
# Memetron
-Identify and parse internet "memes" in Ruby
+Identify and parse internet "memes" in Ruby.
## How
@@ -11,20 +11,28 @@ Memetron::Matcher.match('A wild Ruby library appears')
# => [Memetron::Pokemon, 'Ruby Library']
```
-## Make your own meme using the awesome DSL
+## Make your own meme using the DSL
```ruby
module Memetron
class SeanBean < Meme
+ # define meme as a regular expression
matcher /Prepare yourself,? (.*) are coming/i
-
+
+ # provide some test cases
should_match "prepare yourself, the automatically generated memes are coming"
and_return "the automatically generated memes"
+
+ should_not_match "this isn't an example of the Sean Bean meme"
end
end
```
+## Contributing Memes
+
+Submit a pull request with your meme and at least one positive example.
+
## Why?
For the lulz.

0 comments on commit 5e5df4f

Please sign in to comment.