X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=README;h=afebd1bd1c56279c0f827ad5db6a2b52f910acc8;hb=1f94a0ed5e46ce48de0384f0e463ef6bc75ff2a6;hp=8abcbd1ccd7c7afcc0b076e617b4860e6c65a84e;hpb=4327d775b89cfbc5f8ad526d51244ee8beec8866;p=angular-mojolicious.git

diff --git a/README b/README
index 8abcbd1..afebd1b 100644
--- a/README
+++ b/README
@@ -1,11 +1,72 @@
-REST JSONP server using Mojolicious for <angular/>
+REST JSONP server using mojolicious for <angular/>
 
 
 <angular/>: Complex web apps made simple
-
 http://angularjs.org/
 
 
 mojolicious: the web in the box!
-
 http://mojolicious.org/
+
+
+This is my attempt to implement REST API described at:
+
+http://docs.getangular.com/REST.Basic
+
+using CouchDB HTTP view API
+
+http://wiki.apache.org/couchdb/HTTP_view_API
+
+to provide storage for experimenting with local datasets using angular $resource API.
+You can also query CouchDB views $xhr("JSON", ...) in angular through angular-server.pl
+
+
+At it's current stage it provides support for angular $resource get, query and $save
+
+http://angularjs.org/Service:$resource
+
+
+Replication of data between instances using angular REST API can be done with:
+
+	# create local CouchDB database
+	curl -X PUT http://localhost:5984/test
+
+	./angular-replicate.pl \
+		http://dpavlin.getangular.com/data/conference \
+		http://localhost:3000/data/test
+
+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
+
+Optionally build angular to get single file download
+
+	cd public/angular
+	rake compile
+	cd -
+
+Start it with:
+
+	./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
+- public/app/conference - new application layout with latest example confernce submission
+
+	curl -X PUT http://localhost:5984/conference/_design/symposium \
+		-d @public/app/conference/_design/symposium
+
+
+Roadmap:
+
++ implement angular-server.pl which implements REST API supported by $resource in angular
++ persistency to local CouchDB, and use views to query data
+- tests