Skip to content

Commit 07f8819

Browse files
committed
Update docs.
1 parent d63b350 commit 07f8819

File tree

2 files changed

+23
-19
lines changed

2 files changed

+23
-19
lines changed

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@
1717
Mitt was made for the browser, but works in any JavaScript runtime. It has no dependencies and supports IE9+.
1818

1919
## Table of Contents
20-
- [Install](#install)
21-
- [Usage](#usage)
22-
- [Examples & Demos](#examples--demos)
23-
- [API](#api)
24-
- [Contribute](#contribute)
25-
- [License](#license)
20+
21+
- [Install](#install)
22+
- [Usage](#usage)
23+
- [Examples & Demos](#examples--demos)
24+
- [API](#api)
25+
- [Contribute](#contribute)
26+
- [License](#license)
2627

2728
## Install
2829

@@ -47,6 +48,7 @@ The [UMD](https://github.com/umdjs/umd) build is also available on [unpkg](https
4748
```html
4849
<script src="https://unpkg.com/mitt/dist/mitt.umd.js"></script>
4950
```
51+
5052
You can find the library on `window.mitt`.
5153

5254
## Usage
@@ -93,7 +95,7 @@ let emitter: mitt.Emitter = new mitt();
9395

9496
Mitt: Tiny (~200b) functional event emitter / pubsub.
9597

96-
Returns **Mitt**
98+
Returns **Mitt**
9799

98100
#### emit
99101

@@ -130,27 +132,29 @@ Remove an event handler for the given type.
130132
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the `mitt` instance for chaining
131133

132134
## Contribute
135+
133136
First off, thanks for taking the time to contribute!
134137
Now, take a moment to be sure your contributions make sense to everyone else.
135138

136139
### Reporting Issues
140+
137141
Found a problem? Want a new feature? First of all see if your issue or idea has [already been reported](../../issues).
138142
If don't, just open a [new clear and descriptive issue](../../issues/new).
139143

140144
### Submitting pull requests
145+
141146
Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.
142147

143-
- Fork it!
144-
- Clone your fork: `git clone https://github.com/<your-username>/mitt`
145-
- Navigate to the newly cloned directory: `cd mitt`
146-
- Create a new branch for the new feature: `git checkout -b my-new-feature`
147-
- Install the tools necessary for development: `npm install`
148-
- Make your changes.
149-
- Commit your changes: `git commit -am 'Add some feature'`
150-
- Push to the branch: `git push origin my-new-feature`
151-
- Submit a pull request with full remarks documenting your changes.
148+
- Fork it!
149+
- Clone your fork: `git clone https://github.com/<your-username>/mitt`
150+
- Navigate to the newly cloned directory: `cd mitt`
151+
- Create a new branch for the new feature: `git checkout -b my-new-feature`
152+
- Install the tools necessary for development: `npm install`
153+
- Make your changes.
154+
- Commit your changes: `git commit -am 'Add some feature'`
155+
- Push to the branch: `git push origin my-new-feature`
156+
- Submit a pull request with full remarks documenting your changes.
152157

153158
## License
154159

155-
[MIT License](LICENSE.md) &copy; [Jason Miller](https://jasonformat.com/)
156-
160+
[MIT License](LICENSE.md) © [Jason Miller](https://jasonformat.com/)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "mitt",
33
"amdName": "mitt",
44
"version": "1.0.1",
5-
"description": "Tiny ~200b functional event emitter / pubsub.",
5+
"description": "Tiny 200b functional Event Emitter / pubsub.",
66
"jsnext:main": "src/index.js",
77
"main": "dist/mitt.js",
88
"umd:main": "dist/mitt.umd.js",

0 commit comments

Comments
 (0)