example for kinosearch external process

[angular-mojolicious.git] / README

diff --git a/README b/README
index b880463..45493f5 100644 (file)
--- a/README
+++ b/README
@@ -17,7 +17,8 @@ using CouchDB HTTP view API
 
 http://wiki.apache.org/couchdb/HTTP_view_API
 
-to provide storage for experimenting with local datasets using angular.
+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
@@ -58,11 +59,46 @@ 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
 
 
-Planned features:
 
-- run queries against data using REST API (currently only simple get is supported)
+CouchDB examples:
+
+       couchdb-changes.pl - simple _changes feed watcher using Mojo::Client documented at
+
+               http://wiki.apache.org/couchdb/HTTP_database_API#Changes
+
+
+       couchdb-trigger.pl - FSM document with hook for user-defiend triggers
+
+               trigger/shell.pm - execute shell commands
+               trigger/email.pm - skeleton for sending e-email
+               trigger/KinoSearch.pm - full-text search
+
+       $ curl -X PUT http://localhost:5984/trigger_demo
+       {"ok":true}
+
+       $ ./couchdb-trigger.pl http://localhost:5984/trigger_demo trigger/shell.pm
+
+       $ curl -X PUT http://localhost:5984/trigger_demo/t1 -d '{"trigger":{"command":"notify-send CouchDB t1"}}'
+
+
+       couchdb-external-kinosearch.pl - external searcher for KinoSearch indexes
+               (configuration for CouchDB is included at end of file)
+
+       $ ./couchdb-trigger.pl http://localhost:5984/trigger_demo trigger/KinoSearch.pm
+
+       $ curl 'http://localhost:5984/trigger_demo/_kinosearch?include_docs=true;q=foobar'
+
+
+
+Roadmap:
+
++ implement angular-server.pl which implements REST API supported by $resource in angular
++ persistency to local CouchDB, and use views to query data
++ implement CouchDB _changes and FSM inside document as base for queue or triggers
+- tests