aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2015-01-25 17:30:58 -0500
committerTeddy Wing2015-01-25 17:30:58 -0500
commit28e22a02c8c326df93093644d9de3fa71185ffe4 (patch)
tree53f3d05d732aab8e604bffc87e09ee9a24a70a99
parent0ec62bcbe1abc707d1ce8ac47aefe378f0ae361e (diff)
downloadNotes-angular-demo-28e22a02c8c326df93093644d9de3fa71185ffe4.tar.bz2
Add README & LICENSE
* Add a basic README with a screenshot of the application and instructions on running the server. * Add MIT license file
-rw-r--r--LICENSE19
-rw-r--r--README.md25
-rw-r--r--README.rdoc28
-rw-r--r--screenshots/main.pngbin0 -> 48608 bytes
4 files changed, 44 insertions, 28 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0f2573c
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2015 Teddy Wing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
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.
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
-<tt>rake doc:app</tt>.
diff --git a/screenshots/main.png b/screenshots/main.png
new file mode 100644
index 0000000..d7073c4
--- /dev/null
+++ b/screenshots/main.png
Binary files differ