1
|
# use [![NPM version](https://img.shields.io/npm/v/use.svg?style=flat)](https://www.npmjs.com/package/use) [![NPM monthly downloads](https://img.shields.io/npm/dm/use.svg?style=flat)](https://npmjs.org/package/use) [![NPM total downloads](https://img.shields.io/npm/dt/use.svg?style=flat)](https://npmjs.org/package/use) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/use.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/use)
|
2
|
|
3
|
> Easily add plugin support to your node.js application.
|
4
|
|
5
|
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
|
6
|
|
7
|
## Install
|
8
|
|
9
|
Install with [npm](https://www.npmjs.com/):
|
10
|
|
11
|
```sh
|
12
|
$ npm install --save use
|
13
|
```
|
14
|
|
15
|
A different take on plugin handling! This is not a middleware system, if you need something that handles async middleware, [ware](https://github.com/segmentio/ware) is great for that.
|
16
|
|
17
|
## Usage
|
18
|
|
19
|
```js
|
20
|
const use = require('use');
|
21
|
```
|
22
|
|
23
|
See the [examples folder](./examples) for usage examples.
|
24
|
|
25
|
## About
|
26
|
|
27
|
<details>
|
28
|
<summary><strong>Contributing</strong></summary>
|
29
|
|
30
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
31
|
|
32
|
</details>
|
33
|
|
34
|
<details>
|
35
|
<summary><strong>Running Tests</strong></summary>
|
36
|
|
37
|
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
|
38
|
|
39
|
```sh
|
40
|
$ npm install && npm test
|
41
|
```
|
42
|
|
43
|
</details>
|
44
|
|
45
|
<details>
|
46
|
<summary><strong>Building docs</strong></summary>
|
47
|
|
48
|
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
|
49
|
|
50
|
To generate the readme, run the following command:
|
51
|
|
52
|
```sh
|
53
|
$ npm install -g verbose/verb#dev verb-generate-readme && verb
|
54
|
```
|
55
|
|
56
|
</details>
|
57
|
|
58
|
### Related projects
|
59
|
|
60
|
You might also be interested in these projects:
|
61
|
|
62
|
* [base-plugins](https://www.npmjs.com/package/base-plugins): Adds 'smart plugin' support to your base application. | [homepage](https://github.com/node-base/base-plugins "Adds 'smart plugin' support to your base application.")
|
63
|
* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base "Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks")
|
64
|
* [ware](https://www.npmjs.com/package/ware): Easily create your own middleware layer. | [homepage](https://github.com/segmentio/ware "Easily create your own middleware layer.")
|
65
|
|
66
|
### Contributors
|
67
|
|
68
|
| **Commits** | **Contributor** |
|
69
|
| --- | --- |
|
70
|
| 37 | [jonschlinkert](https://github.com/jonschlinkert) |
|
71
|
| 7 | [charlike-old](https://github.com/charlike-old) |
|
72
|
| 2 | [doowb](https://github.com/doowb) |
|
73
|
| 2 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |
|
74
|
|
75
|
### Author
|
76
|
|
77
|
**Jon Schlinkert**
|
78
|
|
79
|
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
|
80
|
* [GitHub Profile](https://github.com/jonschlinkert)
|
81
|
* [Twitter Profile](https://twitter.com/jonschlinkert)
|
82
|
|
83
|
### License
|
84
|
|
85
|
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
|
86
|
Released under the [MIT License](LICENSE).
|
87
|
|
88
|
***
|
89
|
|
90
|
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 12, 2018._
|