Skip to content

Commit

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

* 1.3.0

* Update packages

* Rename repo

* Create .npmignore
  • Loading branch information
gohabereg committed Mar 1, 2019
1 parent b8dea69 commit 522f4bc
Show file tree
Hide file tree
Showing 8 changed files with 3,948 additions and 5,351 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
18 changes: 9 additions & 9 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)

# InlineCode Tool

Inline Tool for marking code-fragments for the [CodeX Editor](https://ifmo.su/editor).
Inline Tool for marking code-fragments for the [Editor.js](https://ifmo.su/editor).

![](assets/example.gif)

Expand All @@ -13,13 +13,13 @@ Inline Tool for marking code-fragments for the [CodeX Editor](https://ifmo.su/ed
Get the package

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

Include module at your application

```javascript
const InlineCode = require('codex.editor.inline-code');
const InlineCode = require('@editorjs/inline-code');
```

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

### Load from CDN

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

`https://cdn.jsdelivr.net/npm/codex.editor.inline-code@1.0.1`
`https://cdn.jsdelivr.net/npm/@editorjs/inline-code@1.0.1`

Require this script on a page with CodeX Editor.
Require this script on a 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 522f4bc

Please sign in to comment.