Skip to content

Commit

Permalink
UPDATE(README.md): update documentation
Browse files Browse the repository at this point in the history
Update documentation and add dependency status badge from version eye.
  • Loading branch information
Alberto Iglesias Gallego committed Nov 30, 2016
1 parent d30a82b commit bc063c2
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
[![Build Status](https://travis-ci.org/master-tools/middle-inyector.svg?branch=master)](https://travis-ci.org/master-tools/middle-inyector)
[![Dependency Status](https://www.versioneye.com/user/projects/583d9c098de3f3004d1ebd60/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/583d9c098de3f3004d1ebd60)
[![Coverage Status](https://coveralls.io/repos/github/master-tools/middle-inyector/badge.svg)](https://coveralls.io/github/master-tools/middle-inyector)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6883719a1d324162a1cec89c7e7f2380)](https://www.codacy.com/app/alberto-uchiha/middle-inyector?utm_source=github.com&utm_medium=referral&utm_content=master-tools/middle-inyector&utm_campaign=Badge_Grade)

Middle-inyector
---------------
This module prevent to waste time in each test for middleware that needs
specific dependencies. You will save code and time on it. A good point of
this project is that is open for more frameworks that's work similar but
right now is just prepare for Express.
Module to inject dependencies and variables for frameworks that works on
NodeJS and middlewares. You could use it to inicialize the app more organiazed
or use it on your middleware test. You will spend less code, time and the
project is open source.

Install
-------
To install middle-inyector you can run the next command:

`npm install --save-dev github:master-tools/middle-inyector`

Example
-------
`npm install --save github:master-tools/middle-inyector`

Test
----
If you want to check the test of this project you can run it with the next
If you want to check the test of the project you can run it with the next
command:

`npm run test`
`npm run test`

Examples
--------
You can view some examples to know how to use it or give you some ideas of
witch cases could do it in the next repository:

- https://master-tools.gitbooks.io/middle-inyector-examples/content/

Contribute
----------
If you want to contribute, you can do it writing a pull request and following
the next rules on yout commits:

- https://git-scm.com/book/ch5-2.html
- https://github.com/erlang/otp/wiki/writing-good-commit-messages
- http://chris.beams.io/posts/git-commit/

0 comments on commit bc063c2

Please sign in to comment.