Skip to content

Commit

Permalink
Merge pull request #98 from editor-js/update/readme
Browse files Browse the repository at this point in the history
Readme.md Updated
  • Loading branch information
robonetphy authored Nov 9, 2023
2 parents 87fa313 + 5bbb817 commit 314f398
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,19 @@ Provides Headings Blocks for the [Editor.js](https://ifmo.su/editor).

## Installation

### Install via NPM

Get the package

```shell
npm i --save @editorjs/header
yarn add @editorjs/header
```

Include module at your application

```javascript
const Header = require('@editorjs/header');
import Header from '@editorjs/header';
```

### Download to your project's source dir

1. Upload folder `dist` from repository
2. Add `dist/bundle.js` file to your page.

### Load from CDN

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

`https://cdn.jsdelivr.net/npm/@editorjs/header@latest`

Then require this script on page with Editor.js.

```html
<script src="..."></script>
```
Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/header@latest)

## Usage

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@editorjs/header",
"version": "2.8.0",
"version": "2.8.1",
"keywords": [
"codex editor",
"header",
Expand Down

0 comments on commit 314f398

Please sign in to comment.