README.md in cirru-parser-0.0.1 vs README.md in cirru-parser-0.0.2
- old
+ new
@@ -1,27 +1,46 @@
+
# Cirru::Parser
-TODO: Write a gem description
+Cirru Parser in Ruby
+## Develop
+
+```
+ruby test.rb
+```
+
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cirru-parser'
```
And then execute:
- $ bundle
+```
+$ bundle
+```
Or install it yourself as:
- $ gem install cirru-parser
+```
+$ gem install cirru-parser
+```
## Usage
-TODO: Write usage instructions here
+```ruby
+require 'cirru/parser'
+
+Cirru::Parser.parse 'code', 'filename'
+# => returns tree
+
+Cirru::Parser.pare 'code', 'filename'
+# => returns simplified tree
+```
## Contributing
1. Fork it ( https://github.com/[my-github-username]/cirru-parser/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)