Blame view

node_modules/use/README.md 3.46 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
  # 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)
  
  > Easily add plugin support to your node.js application.
  
  Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
  
  ## Install
  
  Install with [npm](https://www.npmjs.com/):
  
  ```sh
  $ npm install --save use
  ```
  
  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.
  
  ## Usage
  
  ```js
  const use = require('use');
  ```
  
  See the [examples folder](./examples) for usage examples.
  
  ## About
  
  <details>
  <summary><strong>Contributing</strong></summary>
  
  Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
  
  </details>
  
  <details>
  <summary><strong>Running Tests</strong></summary>
  
  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:
  
  ```sh
  $ npm install && npm test
  ```
  
  </details>
  
  <details>
  <summary><strong>Building docs</strong></summary>
  
  _(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.)_
  
  To generate the readme, run the following command:
  
  ```sh
  $ npm install -g verbose/verb#dev verb-generate-readme && verb
  ```
  
  </details>
  
  ### Related projects
  
  You might also be interested in these projects:
  
  * [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.")
  * [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")
  * [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.")
  
  ### Contributors
  
  | **Commits** | **Contributor** | 
  | --- | --- |
  | 37 | [jonschlinkert](https://github.com/jonschlinkert) |
  | 7 | [charlike-old](https://github.com/charlike-old) |
  | 2 | [doowb](https://github.com/doowb) |
  | 2 | [wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) |
  
  ### Author
  
  **Jon Schlinkert**
  
  * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
  * [GitHub Profile](https://github.com/jonschlinkert)
  * [Twitter Profile](https://twitter.com/jonschlinkert)
  
  ### License
  
  Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
  Released under the [MIT License](LICENSE).
  
  ***
  
  _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 12, 2018._