summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPeter Mangiafico2011-04-05 12:03:10 -0700
committerChris Sepic2011-06-28 17:24:00 -0500
commit9e97c290509c1681fbaa9a103332370e331ad9c3 (patch)
treed48a4ea0dfbeab413671373df9bd7922f9f1a08b
parent3c72845c3ffe50bdcba3921a3c51f00331f77a5e (diff)
downloadevernote-9e97c290509c1681fbaa9a103332370e331ad9c3.tar.bz2
more readme adjustments
-rw-r--r--README.mkd8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.mkd b/README.mkd
index 0c2bafc..8e6d79d 100644
--- a/README.mkd
+++ b/README.mkd
@@ -1,14 +1,18 @@
# evernote #
This gem is a high level wrapper around Evernote's Thrift-generated ruby code. It bundles up Evernote's thrift-generated code and creates some simple wrapper classes.
-# usage #
-Get yourself an API key from Evernote, which gives you a "consumer_key" and "consumer_secret". Put those in a YML file or any other place you put configuration information. Also, get yourself a username and password (probably on their sandbox system).
+# setup #
+Get yourself a "Client application" API key from Evernote (http://www.evernote.com/about/developer/api/#key), which gives you a "consumer_key" and "consumer_secret" (note that a "web application" API key uses OAuth to authenticate and will not work). Put the key in a YML file or any other place you put configuration information. Also, get yourself a username and password on both their sandbox system (http://sandbox.evernote.com) and live system. You will be using sandbox for testing.
+# usage #
require 'evernote'
user_store_url = "https://sandbox.evernote.com/edam/user"
config={'username'=>'YOUR_USERNAME','password'=>'YOUR_PASSWORD','consumer_key'=>'YOUR_CONSUMER_KEY_FROM_EVERNOTE','consumer_secret'=>'YOUR_CONSUMER_SECRECT_FROM_EVERNOTE'}
+
+ # note, you could also read in your consumer key information from a YML file
+
user_store = Evernote::UserStore.new(user_store_url, config)
auth_result = user_store.authenticate