You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
3.5 KiB

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