Skip to content

Commit

Permalink
Feature/renaming (#11)
Browse files Browse the repository at this point in the history
* Rename all occurences

* 1.3.0

* Update packages

* Rename repo

* Create .npmignore

* Update README.md
  • Loading branch information
gohabereg committed Mar 2, 2019
1 parent bf49d04 commit bd3d444
Show file tree
Hide file tree
Showing 8 changed files with 3,950 additions and 5,352 deletions.
5 changes: 5 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.idea/
assets/
src/
webpack.config.js
yarn.lock
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
![](https://badgen.net/badge/CodeX%20Editor/v2.0/blue)
![](https://badgen.net/badge/Editor.js/v2.0/blue)

# List Tool for CodeX Editor
# List Tool for Editor.js

This Tool for the [CodeX Editor](https://ifmo.su/editor) allows you to add ordered or unordered (bulleted) lists to your article.
This Tool for the [Editor.js](https://editorjs.io) allows you to add ordered or unordered (bulleted) lists to your article.

![](assets/example.gif)

Expand All @@ -13,13 +13,13 @@ This Tool for the [CodeX Editor](https://ifmo.su/editor) allows you to add order
Get the package

```shell
npm i --save-dev codex.editor.list
npm i --save-dev @editorjs/list
```

Include module at your application

```javascript
const List = require('codex.editor.list');
const List = require('@editorjs/list');
```

### Download to your project's source dir
Expand All @@ -29,22 +29,22 @@ const List = require('codex.editor.list');

### Load from CDN

You can load specific version of package from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/codex.editor.list).
You can load specific version of package from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/@editorjs/list).

`https://cdn.jsdelivr.net/npm/codex.editor.list@1.0.2`
`https://cdn.jsdelivr.net/npm/@editorjs/list@1.0.2`

Then require this script on page with CodeX Editor.
Then require this script on page with Editor.js.

```html
<script src="..."></script>
```

## Usage

Add a new Tool to the `tools` property of the CodeX Editor initial config.
Add a new Tool to the `tools` property of the Editor.js initial config.

```javascript
var editor = CodexEditor({
var editor = EditorJS({
...

tools: {
Expand Down
2 changes: 1 addition & 1 deletion dist/bundle.js

Large diffs are not rendered by default.

Loading

0 comments on commit bd3d444

Please sign in to comment.