From 28e22a02c8c326df93093644d9de3fa71185ffe4 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sun, 25 Jan 2015 17:30:58 -0500 Subject: Add README & LICENSE * Add a basic README with a screenshot of the application and instructions on running the server. * Add MIT license file --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4cf615 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +Angular.js Demo: Notes app +========================== + +This is a demo application to explain the basics of AngularJS. + +It's a basic notes app that allows you to create, view, and update notes. + +![Main screen](screenshots/main.png) + +The `NotesController` provides a CRUD API for notes which is then accessed by an Angular application. + + +## Running The App + +1. Install gems + + $ bundle install --path vendor/bundle + +2. Start the Rails server + + $ bundle exec rails server + + +## License +Licensed under the MIT License. See the included LICENSE file. -- cgit v1.2.3