aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTeddy Wing2015-01-25 17:34:05 -0500
committerTeddy Wing2015-01-25 17:34:05 -0500
commitb75ef2c502bf0da050bd290a2ad1cc7aa0dcc408 (patch)
treebf3bb8b56a2f289aba5fe0d3467368279a7c87ad /README.md
parent005e7cca168c6b4eeb06e314046f58b516c13aec (diff)
parent28e22a02c8c326df93093644d9de3fa71185ffe4 (diff)
downloadNotes-angular-demo-b75ef2c502bf0da050bd290a2ad1cc7aa0dcc408.tar.bz2
Merge branch 'angular-app'
Conflicts: app/assets/stylesheets/layouts/_global.scss app/views/home/main.html.erb
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
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.