haikuable 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +16 -5
- data/lib/haikuable/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
# Haikuable
|
2
2
|
|
3
|
-
|
3
|
+
> Garth: "Does anyone else find this weird? I mean, we're looking down on Wayne's basement. Only that's not Wayne's basement. Isn't that weird?"
|
4
|
+
> Everyone: "That's weird…"
|
5
|
+
> Wayne: "Garth, that was a haiku!"
|
6
|
+
|
7
|
+
True to the simplicity and elegance of the Japanese poetic form, haikuable is a very simple gem. It has a single method. It takes a string, and returns a boolean based on whether or not that string is a haiku.
|
8
|
+
|
9
|
+
## Usage
|
10
|
+
|
11
|
+
```bash
|
12
|
+
>> require 'haikuable'
|
13
|
+
=> true
|
14
|
+
>> poem = 'at the age old pond a frog leaps into water a deep resonance'
|
15
|
+
=> "at the age old pond a frog leaps into water a deep resonance"
|
16
|
+
>> Haikuable::Checker.new(poem).is_haiku?
|
17
|
+
=> true
|
18
|
+
```
|
4
19
|
|
5
20
|
## Installation
|
6
21
|
|
@@ -16,10 +31,6 @@ Or install it yourself as:
|
|
16
31
|
|
17
32
|
$ gem install haikuable
|
18
33
|
|
19
|
-
## Usage
|
20
|
-
|
21
|
-
TODO: Write usage instructions here
|
22
|
-
|
23
34
|
## Contributing
|
24
35
|
|
25
36
|
1. Fork it
|
data/lib/haikuable/version.rb
CHANGED