Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Fix typo and improve Readme formatting #16

Merged
merged 2 commits into from

2 participants

@lackac

No description provided.

@emerleite emerleite merged commit 4b0a9a4 into emerleite:master
@emerleite
Owner

Thanks ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on May 7, 2012
  1. @lackac

    Fix typo

    lackac authored
  2. @lackac

    Improve Readme formatting

    lackac authored lackac committed
This page is out of date. Refresh to see the latest.
Showing with 15 additions and 9 deletions.
  1. +15 −9 Readme.md
View
24 Readme.md
@@ -34,14 +34,18 @@ Dependencies
Instalation
-----------
-> npm install database-cleaner
+```shell
+$ npm install database-cleaner
+```
-Usuage
+Usage
------
-> var DatabaseCleaner = require('database-cleaner');
-> var databaseCleaner = new DatabaseCleaner(type); //type = 'mongodb|redis|couchdb'
->
-> databaseCleaner.clean(database, callback);
+```javascript
+var DatabaseCleaner = require('database-cleaner');
+var databaseCleaner = new DatabaseCleaner(type); //type = 'mongodb|redis|couchdb'
+
+databaseCleaner.clean(database, callback);
+```
### Examples
Take look at test folder to see how it works.
@@ -52,11 +56,13 @@ Running tests
-------------
There is some ways to run tests:
-$ mocha test (you need nodeunit globaly installed. *npm install -g mocha*)
+```shell
+$ mocha test # you need mocha globaly installed. `npm install -g mocha`
$ npm test
+```
-> For tests you need each database running (mongodb, redis, couchdb, mysql)
-> Or run once. Ex: mocha test/redis.test.js
+For tests you need each database running (mongodb, redis, couchdb, mysql)
+Or run once. Ex: `mocha test/redis.test.js`
You can also run tests using local mocha. ./node_modules/mocha/bin/mocha
Something went wrong with that request. Please try again.