Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve README and add LICENSE

  • Loading branch information...
commit 7f7392fb49140e0c1d64a02790208d3da9a3ca1c 1 parent 313c487
@remiprev authored
Showing with 21 additions and 0 deletions.
  1. +3 −0  LICENSE
  2. +18 −0 README.md
View
3  LICENSE
@@ -0,0 +1,3 @@
+Copyright 2012 Rémi Prévost.
+You may use this work without restrictions, as long as this notice is included.
+The work is provided "as is" without warranty of any kind, neither express nor implied.
View
18 README.md
@@ -94,3 +94,21 @@ end
User.popular # => [#<User id=1>, #<User id=2>]
User.total # => 42
```
+
+## Things to be done
+
+* Deleting resources
+* Support for Faraday middleware
+* Hooks before save, update, create, destroy, etc.
+* Better introspection for debug
+* Better documentation
+
+## Contributors
+
+Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/her/issues).
+
+Take a look at the `spec` folder before you do, and make sure `bundle exec rake spec` passes after your modifications :)
+
+## License
+
+Teamocil is © 2012 [Rémi Prévost](http://exomel.com) and may be freely distributed under the [LITL license](https://github.com/remiprev/her/blob/master/LICENSE). See the `LICENSE` file.
Please sign in to comment.
Something went wrong with that request. Please try again.