Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Adriano Raiano committed Apr 27, 2012
1 parent adb83ae commit e72b515
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
15 changes: 12 additions & 3 deletions index.html
Expand Up @@ -35,7 +35,7 @@ <h1>Introduction</h1>
<ul>
<li>load and store events via EventStream object</li>
<li>event dispatching to your publisher</li>
<li>supported Dbs (MongoDb, CouchDb, Redis)</li>
<li>supported Dbs (MongoDb, Redis)</li>
<li>snapshot support</li>
</ul>

Expand All @@ -45,7 +45,7 @@ <h1>Installation</h1>

<p>choose one of the existing storage implementation or provide your own:</p>

<pre><code><span class="com">// for mongoDb</span><span class="pln"><br />npm install eventstore</span><span class="pun">.</span><span class="pln">mongoDb<br /><br /></span><span class="com">// for couchDb</span><span class="pln"><br />npm install eventstore</span><span class="pun">.</span><span class="pln">couchDb<br /><br /></span><span class="com">// for redis</span><span class="pln"><br />npm install eventstore</span><span class="pun">.</span><span class="pln">redis<br /></span></code></pre>
<pre><code><span class="com">// for mongoDb</span><span class="pln"><br />npm install eventstore</span><span class="pun">.</span><span class="pln">mongoDb<br /><br /></span><span class="com">// for redis</span><span class="pln"><br />npm install eventstore</span><span class="pun">.</span><span class="pln">redis<br /></span></code></pre>

<h1>Usage</h1>

Expand All @@ -60,7 +60,7 @@ <h3>Require the module and init the eventstore:</h3>

<h3>Provide implementation for storage and publishing events</h3>

<p>Example will use redis storage, but same will work for mongoDb and couchDb.</p>
<p>Example will use redis storage, but same will work for mongoDb.</p>

<pre><code><span class="kwd">var</span><span class="pln"> storage </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">require</span><span class="pun">(</span><span class="str">'eventstore.redis'</span><span class="pun">);</span><span class="pln"><br /><br />es</span><span class="pun">.</span><span class="pln">configure</span><span class="pun">(</span><span class="kwd">function</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln"><br />&nbsp; &nbsp; es</span><span class="pun">.</span><span class="kwd">use</span><span class="pun">(</span><span class="pln">storage</span><span class="pun">.</span><span class="pln">createStorage</span><span class="pun">());</span><span class="pln"><br />&nbsp; &nbsp; es</span><span class="pun">.</span><span class="kwd">use</span><span class="pun">(</span><span class="pln">publisher</span><span class="pun">);</span><span class="pln"> </span><span class="com">// your publisher must provide function 'publisher.publish(event)'</span><span class="pln"><br />&nbsp; &nbsp; </span><span class="com">// es.use(logger);</span><span class="pln"><br /></span><span class="pun">}).</span><span class="pln">start</span><span class="pun">();</span><span class="pln"><br /></span></code></pre>

Expand Down Expand Up @@ -108,11 +108,20 @@ <h1>Inspiration</h1>

<h2>Release Notes</h2>

<h3>v0.6.0</h3>

<ul>
<li>removed couchDb implementation</li>
<li>rewritten tests in mocha and expect.js</li>
<li>updated to node.js 0.6.15</li>
</ul>

<h3>v0.5.0</h3>

<ul>
<li>simplified API for storage usage</li>
<li>if possible fork dispatching to own childprocess</li>
<li>optimized lastRevision handling</li>
</ul>

<h3>v0.3.0</h3>
Expand Down
14 changes: 9 additions & 5 deletions source/content.md
Expand Up @@ -4,7 +4,7 @@ The project goal is to provide an eventstore implementation for node.js:

- load and store events via EventStream object
- event dispatching to your publisher
- supported Dbs (MongoDb, CouchDb, Redis)
- supported Dbs (MongoDb, Redis)
- snapshot support

# Installation
Expand All @@ -16,9 +16,6 @@ choose one of the existing storage implementation or provide your own:
// for mongoDb
npm install eventstore.mongoDb

// for couchDb
npm install eventstore.couchDb

// for redis
npm install eventstore.redis

Expand All @@ -37,7 +34,7 @@ with option `eventstore.createStore({logger: 'console'});`.

### Provide implementation for storage and publishing events

Example will use redis storage, but same will work for mongoDb and couchDb.
Example will use redis storage, but same will work for mongoDb.

var storage = require('eventstore.redis');

Expand Down Expand Up @@ -120,10 +117,17 @@ You can find the code documentation [here](public/docs/eventStore.html).

## Release Notes

### v0.6.0

- removed couchDb implementation
- rewritten tests in mocha and expect.js
- updated to node.js 0.6.15

### v0.5.0

- simplified API for storage usage
- if possible fork dispatching to own childprocess
- optimized lastRevision handling

### v0.3.0

Expand Down

0 comments on commit e72b515

Please sign in to comment.