Add scripts to create myops-getqueryview:
[myops.git] / web / query / README.md
diff --git a/web/query/README.md b/web/query/README.md
new file mode 100644 (file)
index 0000000..d8e3664
--- /dev/null
@@ -0,0 +1,44 @@
+# Sofa: Standalone CouchDB Blog
+
+Sofa showcases the [potential of pure CouchDB applications](http://jchris.mfdz.com/code/2008/10/standalone_applications_with_co). It should provide an easy way for people to put thier thoughts online, anywhere there's a running Couch. It's just HTML, JavaScript and the magic of CouchDB.
+
+Currently supports authoring by anyone with the proper roles, and comments from anyone with a user account.
+
+## Current News
+
+Things are moving crazy fast around here right now as I bring this stuff up to ship-shape for the [CouchDB book](http://books.couchdb.org). I'll be renaming methods and stuff (if I find the time), any API feedback will be appreciated.
+
+## Install CouchDB
+
+You'll also need CouchDB (verion 0.11 or newer). Once you have that installed and the tests passing, you can install CouchApp
+and the blog software. 
+
+## Install CouchApp
+
+CouchApp makes it easy to edit application that are hosted in CouchDB, by keeping a correspondence between a set of files, and a CouchDB design document. You'll use CouchApp to install Sofa in your CouchDB instance.
+
+    sudo easy_install couchapp
+
+CouchApp is a set of utilities for developing standalone CouchDB applications You can [learn more about the CouchApp project here](http://github.com/couchapp/couchapp/). Also, [`easy_install` has an unpleasant bug on OSX](http://mail.python.org/pipermail/pythonmac-sig/2008-October/020567.html), so you might end up having to work from git source.
+
+
+### Setup Admin Access
+
+If you are going to put your blog in public, you'll want to [set up an Admin account (screencast)](http://www.youtube.com/watch?v=oHKvV3Nh-CI).
+
+
+## Install Sofa
+
+    git clone git://github.com/jchris/sofa.git
+    cd sofa
+    couchapp push . http://user:pass@127.0.0.1:5984/myblogdb 
+  
+You'll want to edit the HTML and CSS to personalize your site. Don't worry, the markup is pretty basic, so it's easy to rework. Adding new features is just a few lines of JavaScript away.
+
+Anytime you make edits to the on-disk version of Sofa, and want to see them in your browser, just run `couchapp push . http://127.0.0.1:5984/blogdb` again. **You probably want to setup your `.couchapprc` file.** You should read the CouchApp readme to learn about that.
+
+You can customize the blog title and other stuff in the `blog.json` file.
+
+# Relax
+
+[Visit your new blog.](http://127.0.0.1:5984/blogdb/_design/sofa/_list/index/recent-posts?descending=true&limit=5)
\ No newline at end of file