README.textile in mite-rb-0.1.0 vs README.textile in mite-rb-0.2.0
- old
+ new
@@ -1,17 +1,21 @@
The official ruby library for interacting with the "RESTful API":http://mite.yo.lk/en/api of "mite":http://mite.yo.lk/en, a sleek time tracking webapp.
h3. Install
-As a ruby gem from github:
+As a ruby gem from gemcutter:
- sudo gem install yolk-mite-rb -s http://gems.github.com
+ sudo gem install mite-rb -s http://gemcutter.org
mite-rb requires activeresource and activesupport gems in a current version (2.3.2) to be installed.
h3. Documentation
+You should read the complete mite.api documentation at http://mite.yo.lk/en/api
+
+h4. Authenticate
+
The first thing you need to set is the account name. This is the same as the web address (subdomain) for your account. For example if you use mite from the domain demo.mite.yo.lk:
Mite.account = 'demo'
Then, you should set the authentication. You can either use your login credentials (email and password) with HTTP Basic Authentication or your mite.api key. In both cases you must enable the mite.api in your user settings.
@@ -22,12 +26,24 @@
or, use your api key:
Mite.key = 'cdfeasdaabcdefgssaeabcdefg'
-You should read the complete mite.api documentation at http://mite.yo.lk/en/api
+h4. Validate connection
+You can validate the connection/authentication with
+
+ Mite.validate
+
+This will return true when the connection is valid and false if not.
+
+Use
+
+ Mite.validate!
+
+and mite-rb will raise an exception with further details when the connection is not valid.
+
h4. Project
Find all active projects of the current account
Mite::Project.all
@@ -59,12 +75,7 @@
Deleting a project
project = Mite::Project.find(1209)
project.destroy
-
-Restore a destroyed project
-(will only work for aprox. 12 hours after the object was destroyed)
-
- project = Mite::Project.undo_destroy(1209)