diff --git a/README.md b/README.md index dbffec969..5637ebe1f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -**Features** +# Standard Notes + +This web app is available on https://app.standardnotes.org. + +For more information on Standard Notes, see https://standardnotes.org. + +## Features - Grouping of notes - Auto-save @@ -8,3 +14,16 @@ - Quick filtering - Full screen writing - Simple UI + +## Running locally + +1. Clone the repo +1. `bundle install` +1. `npm install` +1. `bundle exec rake bower:install` +1. `grunt` +5. `rails s` + +Open your browser to http://localhost:3000 + +In the bottom left, click on "Sign in or Register" or "Account" (if signed in), and make sure you're using the correct server. You can use a production server here as usual (like https://n3.standardnotes.org).