Mercurial > browser-couch

annotate index.html @ 71:b89ed0374486

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Linked to tutorial from index page.
author Atul Varma <varmaa@toolness.com>
date Mon, 20 Apr 2009 13:18:19 -0700
parents 71df4d77dbf6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
4 <head>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
5 <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
6 <link rel="stylesheet" type="text/css" media="all"
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
7 href="css/docs.css" />
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
8 <title>BrowserCouch Documentation</title>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
9 </head>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
10 <body>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
11 <div id="content">
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
12 <div id="overview" class="documentation" style="display: none;">
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
13 <h1>BrowserCouch Documentation</h1>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
14 <p>BrowserCouch is an attempt at an
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
15 in-browser <a href="http://en.wikipedia.org/wiki/MapReduce">MapReduce</a>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
16 implementation. It's written entirely in JavaScript and intended
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
17 to work on all browsers, gracefully upgrading when support for
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
18 better efficiency or feature set is detected.</p>
65
a69d57c2c50f Added a note about CouchDB in the docs.
Atul Varma <varmaa@toolness.com>
parents: 58
diff changeset
19 <p>Not coincidentally, this library is intended to mimic the
a69d57c2c50f Added a note about CouchDB in the docs.
Atul Varma <varmaa@toolness.com>
parents: 58
diff changeset
20 functionality
a69d57c2c50f Added a note about CouchDB in the docs.
Atul Varma <varmaa@toolness.com>
parents: 58
diff changeset
21 of <a href="http://en.wikipedia.org/wiki/CouchDB">CouchDB</a> on
a69d57c2c50f Added a note about CouchDB in the docs.
Atul Varma <varmaa@toolness.com>
parents: 58
diff changeset
22 the client-side, and may even support integration with CouchDB in
a69d57c2c50f Added a note about CouchDB in the docs.
Atul Varma <varmaa@toolness.com>
parents: 58
diff changeset
23 the future.</p>
66
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
24
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
25 <h2>Why?</h2>
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
26
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
27 <p>This prototype is intended as a response to Vladimir
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
28 Vukićević's blog post
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
29 entitled <a href="http://blog.vlad1.com/2009/04/06/html5-web-storage-and-sql/">HTML5
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
30 Web Storage and SQL</a>. A CouchDB-like API seems like a nice
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
31 solution to persistent storage on the Web because so many of its
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
32 semantics are delegated out to the JavaScript language, which
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
33 makes it potentially easy to standardize. Furthermore, the
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
34 MapReduce paradigm also naturally takes advantage of multiple
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
35 processor cores&mdash;something that is increasingly common in
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
36 today's computing devices.</p>
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
37
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
38 <h2>Things to do</h2>
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
39
71
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
40 <p>To learn how to use BrowserCouch, check out the
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
41 work-in-progress <a class="intra-wiki"
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
42 href="tutorial.html">tutorial</a>.</p>
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
43
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
44 <p>Aside from that, you can run the <a class="intra-wiki"
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
45 href="tests.html">test suite</a> and the <a class="intra-wiki"
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
46 href="big.html">semi-large data set test</a>, though they're not
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
47 particularly exciting. In the future, we'd like to make CouchDB's
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
48 <a href="http://couchdb.apache.org/screenshots.html">Futon</a>
66
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
49 client work entirely using BrowserCouch as its backend instead of
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
50 a CouchDB server, but that's a ways away.</p>
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
51
71
b89ed0374486 Linked to tutorial from index page.
Atul Varma <varmaa@toolness.com>
parents: 66
diff changeset
52 <p>If you'd like to see more code samples of what the BrowserCouch
66
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
53 API currently looks like, check out the <a class="intra-wiki"
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
54 href="#js/tests.js">annotated source code for the test suite</a>.
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
55 You can also read the <a class="intra-wiki"
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
56 href="#js/browser-couch.js">primary source code documentation</a>
71df4d77dbf6 Added lots more text to index.html.
Atul Varma <varmaa@toolness.com>
parents: 65
diff changeset
57 for more on BrowserCouch's implementation.</p>
57
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
58 </div>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
59 </div>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
60 </body>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
61 <script src="js/ext/jquery.js"></script>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
62 <script src="js/ext/wikicreole.js"></script>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
63 <script type="text/javascript" src="js/ext/docs.js"></script>
147016e199d0 Added code-illuminated documentation.
Atul Varma <varmaa@toolness.com>
parents:
diff changeset
64 </html>