Merge branch 'master' of github.com:dpavlin/angular-mojolicious

[angular-mojolicious.git] / README

diff --git a/README b/README
index 0699a37..dd7aa13 100644 (file)
--- a/README
+++ b/README
@@ -13,16 +13,48 @@ This is my attempt to implement REST API described at:
 
 http://docs.getangular.com/REST.Basic
 
-using simple in-memory model for experimenting with local datasets using
-<angular/>
+using CouchDB HTTP view API
+
+http://wiki.apache.org/couchdb/HTTP_view_API
+
+to provide storage for experimenting with local datasets using angular.
+
+
+At it's current stage it provides support for angular $resource get, query and $save
+
+http://angularjs.org/Service:$resource
+
+
+Server also supports replication using same API which can be triggered with
+
+ http://localhost:3000/_replicate?from=http://dpavlin.getangular.com/data/conference/
+
+Replication is currently good only for initial import of data since it doesn't
+support incremental replication and dies if data is allready present.
 
 
 Installation:
 
-    git submodule init
-    git submodule update
+       git submodule init
+       git submodule update
+
+Optionally build angular to get single file download
+
+       cd public/angular
+       rake compile
+       cd -
 
 Start it with:
 
-    ./angular-server.pl daemon --reload  
+       ./angular-server.pl daemon --reload  
+
+
+Angular examples available:
+
+- template/Cookbook - examples from wiki working against github version of angular
+- template/conferece - conference submission example using mojolicious REST API server
+
+
+Planned features:
 
+- run queries against data using REST API (currently only simple get is supported)