From 20ad1319909a92dd4437bc93af34890ebf891ea6 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Thu, 31 Dec 2015 01:12:06 -0800 Subject: Add README Include some background information, setup and run steps, and license information. --- README.md | 37 +++++++++++++++++++++++++++++++++++++ README.rdoc | 28 ---------------------------- 2 files changed, 37 insertions(+), 28 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 0000000..4ce34f0 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +Evernote Rails Example +====================== + +This is an example app written for @zenkbaries that demonstrates Evernote +integration in a Rails app. + +It uses [OmniAuth](https://github.com/intridea/omniauth) and [Omniauth +Evernote](https://github.com/szimek/omniauth-evernote) for authentication. +Interfacing with the Evernote API is done via Evernote's [Ruby +SDK](https://github.com/evernote/evernote-sdk-ruby) and a [wrapper +gem](https://github.com/teddywing/evernote) originally written by Chris Sepic +and extended by kipcole9. + + +## Setup +First obtain an API key from https://dev.evernote.com/. + +Then run: + + $ sh setup.sh + +Edit the `.env` file and fill in your API keys. + + +## Running +Start the server as usual with `rails server`. The index page at +`http://localhost:3000` will display a link that can be used to authenticate +with Evernote. At the moment, going through the OAuth process just writes the +resulting auth hash to the server log. + +The hard-coded access token and NoteStore URL in `NotesController` can be filled +in with appropriate values to access an authorized user's notes. Those notes can +be viewed by visiting the `/notes` page. + + +## License +Licensed under the MIT license. See the included LICENSE file. diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e..0000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app. -- cgit v1.2.3