Commits

Alexander Shorin committed 0a75c8a

Fix README typos and CowDB naming

Comments (0)

Files changed (2)

 #cowdb
 
-Cowdb implements an indexed, key/value storage engine. The primary index
-is an append-only btree implemented using CBT a btree library extracted
-from Apache CouchDB .
+CowDB implements an indexed, key/value storage engine. The primary index
+is an append-only btree which is implemented by CBT - a btree library
+extracted from Apache CouchDB .
 
-CowdDB is released under the Apache License 2.
+CowDB is released under the Apache License 2.
 
 ## Features
 
 values in a transaction. You can use them to ensure atomic
 read-modify-update processing, and integrity constraints.
 - Transaction log
-- Snapshotting support: You are able to take a snapshot of the database
+- Snapshots support: you are able to take a snapshot of the database
   at any time (until the database is compacted)
 - Destructive compaction to reclaim space in your database. The log
   history is lost during the transaction.
 
 https://wiki.refuge.io/display/COWDB/CowDB+Documentation+Home
 
-main cowdb website on http://cowdb.org
+main CowDB website is http://cowdb.org
 
 
-## build
+## Build process
 
-### 1. install rebar
-To build cowdb you need to install rebar in your `PATH`. Rebar is
+### 1. Install rebar
+To build CowDB you need to install rebar in your `PATH`. Rebar is
 available on Github:
 
 https://github.com/rebar/rebar
 [README](https://github.com/rebar/rebar/blob/master/README.md) to
 install it.
 
-### 2. build
+### 2. Build the sources
 
 Fetch the source code:
 
     $ git clone https://bitbucket.org/refugeio/cowdb.git
 
-Build the source, run the `make` command. It will fetch any needed
+Build the source, run the `make` command. It will fetch all required
 dependencies.
 
     $ cd /<PATH_TO>/cowdb
     $ make
 
 
-### 2. Build the doc
+### 3. Build the docs
 
     $ make doc
 
-and open the `index.html` file in the doc folder. Or read it
+and open the `index.html` file in the doc directory. Or read it
 [online](http://refugeio.bitbucket.org/cowdb/index.html).
 
-### 3. Run tests
+### 4. Run tests
 
     $ make test
 
     10> cowdb:fold(Pid, fun(Got, Acc) -> {ok, [Got | Acc]} end, []).
     {ok,[{d,1},{c,2},{a,1}]}
 
-## contribute
+## Contribute
 
-Open Issues and Support tickets in [Jira](https://issues.refuge.io/browse/CDB
-).
+Open Issues and Support tickets in [Jira](https://issues.refuge.io/browse/CDB).
 Code is available on [bitbucket](https://bitbucket.org/refugeio/cowdb).

doc/overview.edoc

-title cowdb - copy-on-write object database
+title CowDB - copy-on-write object database
 @author Benoit Chesneau <benoitc@refuge.io>
   [http://refuge.io/]
 @copyright 2014 Benoit Chesneau (Apache 2 License)
 @version 0.3.0
-@title cowdb - Pure Key/Value datbase for Erlang Applications
+@title CowDB - Pure Key/Value database for Erlang Applications
 
-@doc cowdb is a Key/Value database for Erlang Applications written in
+@doc CowDB is a Key/Value database for Erlang Applications written in
 full Erlang.