[Pkg-javascript-commits] [node-mocks-http] 139/296: minor formating corrections
Thorsten Alteholz
alteholz at moszumanska.debian.org
Mon Feb 8 18:13:30 UTC 2016
This is an automated email from the git hooks/post-receive script.
alteholz pushed a commit to branch master
in repository node-mocks-http.
commit a6c1ac010b4834a3ec97922228668f7ca2f56169
Author: Johnny Estilles <johnny.estilles at agentia.asia>
Date: Mon Mar 23 12:14:28 2015 +0800
minor formating corrections
---
README.md | 21 +++++++++------------
1 file changed, 9 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 7740a15..169a7ff 100644
--- a/README.md
+++ b/README.md
@@ -10,24 +10,24 @@ routing functions, but could be used for testing any
[Node.js](http://www.nodejs.org) web server applications that have
code that requires mockups of the `request` and `response` objects.
-Installation
----
+## Installation
This project is available as a
[NPM package](https://www.npmjs.org/package/node-mocks-http).
```bash
-$ npm install node-mocks-http
+$ npm install --save-dev node-mocks-http
```
+> Our example includes `--save-dev` based on the assumption that **node-mocks-http** will be used as a development dependency..
+
After installing the package include the following in your test files:
```js
var httpMocks = require('node-mocks-http');
```
-Usage
----
+## Usage
Suppose you have the following Express route:
@@ -74,8 +74,7 @@ exports['routeHandler - Simple testing'] = function(test) {
};
```
-Design Decisions
----
+## Design Decisions
We wanted some simple mocks without a large framework.
@@ -83,8 +82,7 @@ We also wanted the mocks to act like the original framework being
mocked, but allow for setting of values before calling and inspecting
of values after calling.
-For Developers
----
+## For Developers
We are looking for more volunteers to bring value to this project,
including the creation of more objects from the
@@ -94,11 +92,10 @@ This project doesn't address all features that must be
mocked, but it is a good start. Feel free to send pull requests,
and a member of the team will be timely in merging them.
-If you wish to contribute please read our [contributing guidelines](CONTRIBUTING.md).
+If you wish to contribute please read our [Contributing Guidelines](CONTRIBUTING.md).
-Release Notes
----
+## Release Notes
Most releases fix bugs with our mocks or add features similar to the
actual `Request` and `Response` objects offered by Node.js and extended
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-mocks-http.git
More information about the Pkg-javascript-commits
mailing list