Skip to content
Browse files

Note about API keys, credits, bla

  • Loading branch information...
1 parent 20dc6c4 commit 936f0c15e34e7d3f750d77f96325816407639a4e @txus committed Dec 6, 2011
Showing with 33 additions and 0 deletions.
  1. +33 −0 Readme.md
View
33 Readme.md
@@ -1,3 +1,36 @@
# springpad
Command-line client for [Springpad](http://springpadit.com). Currently WIP.
+
+## Getting an API key
+
+To use this, even to run the tests, you need to be registered at Springpad
+(it's a free service) and also have an API key.
+
+You can [register here](http://springpadit.com/) and [request an API key here](
+http://springpadit.com/developers/oauth/register-app). They give them FAST (I
+got mine the minute after sending the form, no kidding).
+
+After that you have to create a `~/.springpad` file in a YAML format with this
+data:
+
+ user: YOUR_USERNAME
+ password: YOUR_PASSWORD
+ token: YOUR_CONSUMER_KEY
+
+## Running the tests
+
+Once you have the config file in place, you just have to:
+
+ git clone git://github.com/txus/springpad
+ cd springpad
+ bundle install
+ rake
+
+You should see some serious green stuff going on!
+
+## Who's this
+
+This was made by [Josep M. Bach (Txus)](http://txustice.me) under the MIT
+license. I'm [@txustice](http://twitter.com/txustice) on twitter (where you
+should probably follow me!).

0 comments on commit 936f0c1

Please sign in to comment.
Something went wrong with that request. Please try again.