Skip to content

Commit 213a7e3

Browse files
committed
Update README
1 parent 001bf61 commit 213a7e3

File tree

1 file changed

+13
-56
lines changed

1 file changed

+13
-56
lines changed

README.md

Lines changed: 13 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
draft-js-markdown-shortcuts-plugin
2-
==================================
1+
# draft-js-markdown-shortcuts-plugin
32

4-
[![CircleCI](https://circleci.com/gh/ngs/draft-js-markdown-shortcuts-plugin.svg?style=svg)](https://circleci.com/gh/ngs/draft-js-markdown-shortcuts-plugin)
3+
![Run tests](https://github.com/ngs/draft-js-markdown-shortcuts-plugin/workflows/Run%20tests/badge.svg)
54
[![Backers on Open Collective](https://opencollective.com/draft-js-markdown-shortcuts-plugin/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsors/badge.svg)](#sponsors) [![npm](https://img.shields.io/npm/v/draft-js-markdown-shortcuts-plugin.svg)][npm]
65
[![Coverage Status](https://coveralls.io/repos/github/ngs/draft-js-markdown-shortcuts-plugin/badge.svg?branch=master)](https://coveralls.io/github/ngs/draft-js-markdown-shortcuts-plugin?branch=master)
76

@@ -11,10 +10,9 @@ This plugin works with [DraftJS Plugins] wrapper component.
1110

1211
![screen](screen.gif)
1312

14-
[View Demo][Demo]
13+
[View Demo][demo]
1514

16-
Usage
17-
-----
15+
## Usage
1816

1917
```sh
2018
npm i --save draft-js-markdown-shortcuts-plugin
@@ -26,80 +24,39 @@ then import from your editor component
2624
import createMarkdownShortcutsPlugin from 'draft-js-markdown-shortcuts-plugin';
2725
```
2826

29-
Example
30-
-------
27+
## Example
3128

3229
```js
3330
import React, { Component } from 'react';
3431
import Editor from 'draft-js-plugins-editor';
3532
import createMarkdownShortcutsPlugin from 'draft-js-markdown-shortcuts-plugin';
3633
import { EditorState } from 'draft-js';
3734

38-
const plugins = [
39-
createMarkdownShortcutsPlugin()
40-
];
35+
const plugins = [createMarkdownShortcutsPlugin()];
4136

4237
export default class DemoEditor extends Component {
43-
4438
state = {
4539
editorState: EditorState.createEmpty(),
4640
};
4741

48-
onChange = (editorState) => {
42+
onChange = editorState => {
4943
this.setState({
5044
editorState,
5145
});
5246
};
5347

5448
render() {
55-
return (
56-
<Editor
57-
editorState={this.state.editorState}
58-
onChange={this.onChange}
59-
plugins={plugins}
60-
/>
61-
);
49+
return <Editor editorState={this.state.editorState} onChange={this.onChange} plugins={plugins} />;
6250
}
6351
}
6452
```
6553

66-
License
67-
-------
54+
## License
6855

6956
MIT. See [LICENSE]
7057

71-
[Demo]: https://ngs.github.io/draft-js-markdown-shortcuts-plugin
72-
[DraftJS]: https://facebook.github.io/draft-js/
73-
[DraftJS Plugins]: https://github.com/draft-js-plugins/draft-js-plugins
74-
[LICENSE]: ./LICENSE
58+
[demo]: https://ngs.github.io/draft-js-markdown-shortcuts-plugin
59+
[draftjs]: https://facebook.github.io/draft-js/
60+
[draftjs plugins]: https://github.com/draft-js-plugins/draft-js-plugins
61+
[license]: ./LICENSE
7562
[npm]: https://www.npmjs.com/package/draft-js-markdown-shortcuts-plugin
76-
77-
## Contributors
78-
79-
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
80-
<a href="graphs/contributors"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/contributors.svg?width=890&button=false" /></a>
81-
82-
83-
## Backers
84-
85-
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/draft-js-markdown-shortcuts-plugin#backer)]
86-
87-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin#backers" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/backers.svg?width=890"></a>
88-
89-
90-
## Sponsors
91-
92-
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/draft-js-markdown-shortcuts-plugin#sponsor)]
93-
94-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/0/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/0/avatar.svg"></a>
95-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/1/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/1/avatar.svg"></a>
96-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/2/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/2/avatar.svg"></a>
97-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/3/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/3/avatar.svg"></a>
98-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/4/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/4/avatar.svg"></a>
99-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/5/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/5/avatar.svg"></a>
100-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/6/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/6/avatar.svg"></a>
101-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/7/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/7/avatar.svg"></a>
102-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/8/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/8/avatar.svg"></a>
103-
<a href="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/9/website" target="_blank"><img src="https://opencollective.com/draft-js-markdown-shortcuts-plugin/sponsor/9/avatar.svg"></a>
104-
105-

0 commit comments

Comments
 (0)