diff options
| author | Thiago Santos <[email protected]> | 2017-01-29 14:11:06 -0200 |
|---|---|---|
| committer | Jason Miller <[email protected]> | 2017-01-29 11:11:06 -0500 |
| commit | 1fbe781649b09627935cd68f2446f3e1d572e3be (patch) | |
| tree | 36bdcc40c55f46234ec7ac9cae8cc780d071c79e /README.md | |
| parent | 9ffbcdc0a470246ed5fca539e70e42ae2cb50e39 (diff) | |
improve readme and add license file (#35)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 84 |
1 files changed, 68 insertions, 16 deletions
@@ -1,12 +1,12 @@ <p align="center"> - <img src="https://i.imgur.com/BqsX9NT.png" width="256" height="256" alt="mitt"> - <br> - <b>Mitt</b>: tiny 200b functional event emitter / pubsub. + <img src="https://i.imgur.com/BqsX9NT.png" width="300" height="300" alt="mitt"> <br> <a href="https://www.npmjs.org/package/mitt"><img src="https://img.shields.io/npm/v/mitt.svg?style=flat" alt="npm"></a> <a href="https://travis-ci.org/developit/mitt"><img src="https://travis-ci.org/developit/mitt.svg?branch=master" alt="travis"></a> <a href="https://david-dm.org/developit/mitt"><img src="https://david-dm.org/developit/mitt/status.svg" alt="dependencies Status"></a> </p> -## Why Mitt? +# Mitt + +> Tiny 200b functional event emitter / pubsub. - **Microscopic:** weighs less than 200 bytes gzipped - **Useful:** a wildcard `"*"` event type listens to all events @@ -14,21 +14,42 @@ - **Functional:** methods don't rely on `this` - **Great Name:** somehow [mitt](https://npm.im/mitt) wasn't taken -> Mitt was made for the browser, but works in any JavaScript runtime. It has no dependencies and supports IE9+. +Mitt was made for the browser, but works in any JavaScript runtime. It has no dependencies and supports IE9+. -## Examples & Demos +## Table of Contents +- [Install](#install) +- [Usage](#usage) +- [Examples & Demos](#examples--demos) +- [API](#api) +- [Contribute](#contribute) +- [License](#license) -<a href="http://codepen.io/developit/pen/rjMEwW?editors=0110"> - <b>Preact + Mitt Codepen Demo</b> - <br> - <img src="https://i.imgur.com/CjBgOfJ.png" width="278" alt="preact + mitt preview"> -</a> +## Install -* * * +This project uses [node](http://nodejs.org) and [npm](https://npmjs.com). Go check them out if you don't have them locally installed. -## Usage +```sh +$ npm install --save mitt +``` + +Then with a module bundler like [rollup](http://rollupjs.org/) or [webpack](https://webpack.js.org/), use as you would anything else: + +```javascript +// using ES6 modules +import mitt from 'mitt' + +// using CommonJS modules +var mitt = require('mitt') +``` + +The [UMD](https://github.com/umdjs/umd) build is also available on [unpkg](https://unpkg.com): -After installing via `npm install --save mitt`: +```html +<script src="https://unpkg.com/mitt/dist/mitt.umd.js"></script> +``` +You can find the library on `window.mitt`. + +## Usage ```js import mitt from 'mitt' @@ -50,7 +71,13 @@ emitter.on('foo', onFoo) // listen emitter.off('foo', onFoo) // unlisten ``` -* * * +## Examples & Demos + +<a href="http://codepen.io/developit/pen/rjMEwW?editors=0110"> + <b>Preact + Mitt Codepen Demo</b> + <br> + <img src="https://i.imgur.com/CjBgOfJ.png" width="278" alt="preact + mitt preview"> +</a> ## API @@ -58,7 +85,7 @@ emitter.off('foo', onFoo) // unlisten Mitt: Tiny (~200b) functional event emitter / pubsub. -Returns **Mitt** +Returns **Mitt** #### on @@ -87,3 +114,28 @@ If present, `"*"` handlers are invoked prior to type-matched handlers. - `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The event type to invoke - `event` **\[Any]** An event object, passed to each handler + +## Contribute +First off, thanks for taking the time to contribute! +Now, take a moment to be sure your contributions make sense to everyone else. + +### Reporting Issues +Found a problem? Want a new feature? First of all see if your issue or idea has [already been reported](../../issues). +If don't, just open a [new clear and descriptive issue](../../issues/new). + +### Submitting pull requests +Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits. + +- Fork it! +- Clone your fork: `git clone https://github.com/<your-username>/mitt` +- Navigate to the newly cloned directory: `cd mitt` +- Create a new branch for the new feature: `git checkout -b my-new-feature` +- Install the tools necessary for development: `npm install` +- Make your changes. +- Commit your changes: `git commit -am 'Add some feature'` +- Push to the branch: `git push origin my-new-feature` +- Submit a pull request with full remarks documenting your changes. + +## License + +[MIT License](LICENSE.md) © [Jason Miller](https://jasonformat.com/) |
