X-Git-Url: http://git.rot13.org/?p=angular-mojolicious.git;a=blobdiff_plain;f=README;h=dd7aa1383f1a1cbd12ec61f579b57f613b8f0322;hp=0699a370313345bba5494dfc7d2be896ce2d070e;hb=f7b616f2dc0fd09346cdb61be53d0d119bb62354;hpb=29b3090fd5ed50e7d7aa71f007b75c53dc573df6

diff --git a/README b/README
index 0699a37..dd7aa13 100644
--- 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)