summaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.mkd b/README.mkd
index 79fa0a9..fd1fa20 100644
--- a/README.mkd
+++ b/README.mkd
@@ -1,5 +1,10 @@
# evernote #
-This gem is a high level wrapper around Evernote's Thrift-generated ruby code.
+This gem is a high level wrapper around Evernote's Thrift-generated ruby code. It currently just bundles up Evernote's thrift-generated code. After installing, just require the gem in your project:
+
+require 'evernote'
+
+# future releases #
+This gem will eventually provide a cleaner API around the generated code, so you don't feel like you're writing Java.
## Copyright ##
Copyright (c) 2010 Chris Sepic. See LICENSE for details.