README.md in resttestrail-0.0.5 vs README.md in resttestrail-0.1.0
- old
+ new
@@ -1,9 +1,14 @@
# Resttestrail
-TODO: Write a gem description
+Resttestrail is a ruby gem for the TestRail API (v2) which is available with TestRail 3.0 and later.
+Features include:
+
+- Publish test results (add run, get run, delete run, add result for case)
+- Add test case to a section (add case, get case, delete case)
+
## Installation
Add this line to your application's Gemfile:
gem 'resttestrail'
@@ -16,14 +21,14 @@
$ gem install resttestrail
## Usage
-TODO: Write usage instructions here
+See the integration spec for usage.
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/resttestrail/fork )
+1. Fork it ( https://github.com/sfaiqh/resttestrail/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request