Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

changed docs

  • Loading branch information...
commit 00de45cfa301edf1c1b09df798e8d0d61c266222 1 parent e98520b
chrisdew authored
Showing with 15 additions and 22 deletions.
  1. +4 −4 README.md
  2. +5 −12 docs/barricane-db.html
  3. +6 −6 lib/barricane-db.js
8 README.md
View
@@ -55,8 +55,8 @@ Roadmap
-------
* Whether I do anything more to this project, beyond functionality required for some of my other projects, really depends on there being some level of interest in the community. If you want things to happen, please [watch](https://github.com/chrisdew/barricane-db/toggle_watch) this project on [GitHub](https://github.com/chrisdew/barricane-db) and subscribe to the [Google Group](https://groups.google.com/group/barricane-db).
* Some of the features I'd like to add include:
-# Change the DB to an emitter and make the open async.
-# Create a subscribe facility so that webclient-proxy objects can be notified on changes to objects which are displayed on user's browsers.
-# Create a more efficient delta-codec which only logs the changed fields of registered instances.
-# Add ACID transactions.
+* Change the DB to an emitter and make the open async.
+* Create a subscribe facility so that webclient-proxy objects can be notified on changes to objects which are displayed on user's browsers.
+* Create a more efficient delta-codec which only logs the changed fields of registered instances.
+* Add ACID transactions.
* Anything you'd like to add? - Create an issue on GitHub.
17 docs/barricane-db.html
View
@@ -1,5 +1,5 @@
<!DOCTYPE html> <html> <head> <title>barricane-db.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="example-create-database.html"> example-create-database.js </a> <a class="source" href="example-model.html"> example-model.js </a> <a class="source" href="example-read-database.html"> example-read-database.js </a> <a class="source" href="barricane-db.html"> barricane-db.js </a> <a class="source" href="db.html"> db.js </a> <a class="source" href="disk-io.html"> disk-io.js </a> <a class="source" href="swoj-codec.html"> swoj-codec.js </a> <a class="source" href="util.html"> util.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> barricane-db.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> <p>Copyright (c) 2010 Barricane Technology Ltd., All Rights Reserved.
-Released under the MIT open source licence.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h1>BarricaneDB - a transparent object persistence mechanism for NodeJS.</h1> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>Status v0.2.0 - Just about works - there will be bugs.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>BarricaneDB is a persistence layer for <a href="http://nodejs.org/">NodeJS</a> which was developed to meet my following requirements:</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <ul>
+Released under the MIT open source licence.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h1>BarricaneDB </h1> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>Status v0.2.0 - Just about works - there will be bugs.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>BarricaneDB is a persistence layer for <a href="http://nodejs.org/">NodeJS</a> which was developed to meet my following requirements:</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> <ul>
<li>My app's state exists as a heap of objects in RAM. I just want to be able to shutdown my app and get that same heap of objects the next time I start my app.</li>
<li>I don't want to have to add or change more than a dozen lines of code.</li>
<li>I want a proper transaction log, so that the data is resilient against application crashes.</li>
@@ -46,17 +46,10 @@
<ul>
<li>Whether I do anything more to this project, beyond functionality required for some of my other projects, really depends on there being some level of interest in the community. If you want things to happen, please <a href="https://github.com/chrisdew/barricane-db/toggle_watch">watch</a> this project on <a href="https://github.com/chrisdew/barricane-db">GitHub</a> and subscribe to the <a href="https://groups.google.com/group/barricane-db">Google Group</a>.</li>
<li>Some of the features I'd like to add include:</li>
-</ul>
-
-<h1>Change the DB to an emitter and make the open async.</h1>
-
-<h1>Create a subscribe facility so that webclient-proxy objects can be notified on changes to objects which are displayed on user's browsers.</h1>
-
-<h1>Create a more efficient delta-codec which only logs the changed fields of registered instances.</h1>
-
-<h1>Add ACID transactions.</h1>
-
-<ul>
+<li>Change the DB to an emitter and make the open async.</li>
+<li>Create a subscribe facility so that webclient-proxy objects can be notified on changes to objects which are displayed on user's browsers.</li>
+<li>Create a more efficient delta-codec which only logs the changed fields of registered instances.</li>
+<li>Add ACID transactions.</li>
<li>Anything you'd like to add? - Create an issue on GitHub.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">&#182;</a> </div> <p>This file is the entry point for the NPM barricane-db package.
It only exports symbols required from other modules.</p> </td> <td class="code"> <div class="highlight"><pre><span class="kd">var</span> <span class="nx">bdb</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./db&#39;</span><span class="p">);</span>
12 lib/barricane-db.js
View
@@ -1,8 +1,8 @@
// Copyright (c) 2010 Barricane Technology Ltd., All Rights Reserved.
// Released under the MIT open source licence.
-// BarricaneDB - a transparent object persistence mechanism for NodeJS.
-// ====================================================================
+// BarricaneDB
+// ===========
// Status v0.2.0 - Just about works - there will be bugs.
@@ -58,10 +58,10 @@
// -------
// * Whether I do anything more to this project, beyond functionality required for some of my other projects, really depends on there being some level of interest in the community. If you want things to happen, please [watch](https://github.com/chrisdew/barricane-db/toggle_watch) this project on [GitHub](https://github.com/chrisdew/barricane-db) and subscribe to the [Google Group](https://groups.google.com/group/barricane-db).
// * Some of the features I'd like to add include:
-// # Change the DB to an emitter and make the open async.
-// # Create a subscribe facility so that webclient-proxy objects can be notified on changes to objects which are displayed on user's browsers.
-// # Create a more efficient delta-codec which only logs the changed fields of registered instances.
-// # Add ACID transactions.
+// * Change the DB to an emitter and make the open async.
+// * Create a subscribe facility so that webclient-proxy objects can be notified on changes to objects which are displayed on user's browsers.
+// * Create a more efficient delta-codec which only logs the changed fields of registered instances.
+// * Add ACID transactions.
// * Anything you'd like to add? - Create an issue on GitHub.
// This file is the entry point for the NPM barricane-db package.
Please sign in to comment.
Something went wrong with that request. Please try again.