Permalink
Browse files

clean up readme

  • Loading branch information...
1 parent a3693f5 commit 88ca9b047f2c4671aae544dca80f51bdd8ca6ecd Dane Springmeyer committed Feb 26, 2014
Showing with 26 additions and 26 deletions.
  1. +26 −26 README.md
View
@@ -1,14 +1,19 @@
-# NAME
+Asynchronous, non-blocking [SQLite3](http://sqlite.org/) bindings for [Node.js](http://nodejs.org/).
-node-sqlite3 - Asynchronous, non-blocking [SQLite3](http://sqlite.org/) bindings for [Node.js](http://nodejs.org/) 0.2-0.4 (versions 2.0.x), **0.6.13+, 0.8.x, and 0.10.x** (versions 2.1.x).
-
-(Can also run in [node-webkit](https://github.com/rogerwang/node-webkit) if it uses a supported version of Node's engine.)
+[![NPM](https://nodei.co/npm/sqlite3.png)](https://nodei.co/npm/sqlite3/)
[![Build Status](https://travis-ci.org/mapbox/node-sqlite3.png?branch=master)](https://travis-ci.org/mapbox/node-sqlite3)
[![npm package version](https://badge.fury.io/js/sqlite3.png)](https://npmjs.org/package/sqlite3)
+## Depends
+
+ - Node.js v0.8.x or v0.10.x
+
+Binaries for most Node versions and platforms are provided by default via [node-pre-gyp](https://github.com/springmeyer/node-pre-gyp).
-# USAGE
+Also works with [node-webkit](https://github.com/rogerwang/node-webkit) and sqlcipher.
+
+# Usage
**Note:** the module must be [installed](#installing) before use.
@@ -33,26 +38,23 @@ db.serialize(function() {
db.close();
```
+# Features
-
-# FEATURES
-
-* Straightforward query and parameter binding interface
-* Full Buffer/Blob support
-* Extensive [debugging support](https://github.com/mapbox/node-sqlite3/wiki/Debugging)
-* [Query serialization](https://github.com/mapbox/node-sqlite3/wiki/Control-Flow) API
-* [Extension support](https://github.com/mapbox/node-sqlite3/wiki/Extensions)
-* Big test suite
-* Written in modern C++ and tested for memory leaks
-
+ - Straightforward query and parameter binding interface
+ - Full Buffer/Blob support
+ - Extensive [debugging support](https://github.com/mapbox/node-sqlite3/wiki/Debugging)
+ - [Query serialization](https://github.com/mapbox/node-sqlite3/wiki/Control-Flow) API
+ - [Extension support](https://github.com/mapbox/node-sqlite3/wiki/Extensions)
+ - Big test suite
+ - Written in modern C++ and tested for memory leaks
# API
See the [API documentation](https://github.com/mapbox/node-sqlite3/wiki) in the wiki.
-# INSTALLING
+# Installing
You can use [`npm`](https://github.com/isaacs/npm) to download and install:
@@ -67,7 +69,7 @@ It is also possible to make your own build of `sqlite3` from its source instea
It is possible to use the installed package in [node-webkit](https://github.com/rogerwang/node-webkit) instead of the vanilla Node.js, but a rebuild is required before use (see the next section).
-# BUILDING FROM THE SOURCE
+## Source install
Unless building via `npm install` (which uses its own `node-gyp`) you will need `node-gyp` installed globally:
@@ -96,7 +98,7 @@ Note, if building against homebrew-installed sqlite on OS X you can do:
./configure --sqlite=/usr/local/opt/sqlite/
make
-# REBUILDING FOR NODE-WEBKIT
+## Building for node-webkit
Because of ABI differences, only a rebuilt version of `sqlite3` can be used in [node-webkit](https://github.com/rogerwang/node-webkit).
@@ -121,7 +123,7 @@ Remember the following:
Visit the “[Using Node modules](https://github.com/rogerwang/node-webkit/wiki/Using-Node-modules)” article in the node-webkit's wiki for more details.
-# BUILDING AGAINST SQLCIPHER
+## Building for sqlcipher
To run node-sqlite3 against sqlcipher you need to compile from source by passing build options like:
@@ -133,7 +135,7 @@ If your sqlcipher is installed in a custom location, say if you installed it wit
export CPPFLAGS="-I/`brew --prefix`opt/sqlcipher/include"
npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=`brew --prefix`
-# TESTING
+# Testing
[mocha](https://github.com/visionmedia/mocha) is required to run unit tests.
@@ -143,8 +145,7 @@ In sqlite3's directory (where its `package.json` resides) run the following:
npm test
-
-# CONTRIBUTORS
+# Contributors
* [Konstantin Käfer](https://github.com/kkaefer)
* [Dane Springmeyer](https://github.com/springmeyer)
@@ -161,8 +162,7 @@ In sqlite3's directory (where its `package.json` resides) run the following:
* [Mithgol](https://github.com/Mithgol)
-
-# ACKNOWLEDGEMENTS
+# Acknowledgments
Thanks to [Orlando Vazquez](https://github.com/orlandov),
[Eric Fredricksen](https://github.com/grumdrig) and
@@ -171,6 +171,6 @@ Thanks to [Orlando Vazquez](https://github.com/orlandov),
Development of this module is sponsored by [MapBox](http://mapbox.org/).
-# LICENSE
+# License
`node-sqlite3` is [BSD licensed](https://github.com/mapbox/node-sqlite3/raw/master/LICENSE).

0 comments on commit 88ca9b0

Please sign in to comment.