README.md in todo_next-0.0.1 vs README.md in todo_next-0.0.2
- old
+ new
@@ -27,34 +27,44 @@
require 'rubygems'
require 'rspec'
require 'todo_next'
todo_next(<<TEXT)
- A Foobar
- - is white by default
- - can be resized
- truthiness()
- - is always true
- (add more tests)
+ A Foobar
+ √ is white by default
+ ex: puts Foobar.new.colour # => 'white'
+ * can be resized
+ example:
+ foobar.resize!(+10, -2)
+ - can be reset
+ truthiness()
+ is always true
+ is never false
+ (add more tests)
TEXT
+ # √ == passed => same as a comment line
+ # * == current => leading char - '*' - is kept
+ # example blocks (ex:, example:) are ignored, like comments.
#describe "<what you're testing>" do
# specify 'this should happen' do
# .. some code
# end
```
This text is equivalent to :
```ruby
- describe "A Foobar" do
- it "- is white by default"
- describe "- can be resized" do
- it "- is always true"
- end
- it "(add more tests)"
- end
+ describe "A Foobar" do
+ it '* can be resized'
+ it 'can be reset'
+ describe 'truthiness()' do
+ it 'is always true'
+ it 'is never false'
+ end
+ it '(add more tests)'
+ end
```
![screenshot1](https://github.com/alainravet/todo_next/raw/master/doc/screenshot_1.png)
![screenshot1](https://github.com/alainravet/todo_next/raw/master/doc/screenshot_2.png)
@@ -63,5 +73,7 @@
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/alainravet/todo_next)