Skip to content

Commit

Permalink
Merge pull request #86 from editor-js/update/readme
Browse files Browse the repository at this point in the history
The Readme.md updated
  • Loading branch information
robonetphy authored Nov 9, 2023
2 parents 5e34288 + 381bbef commit 674068c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 17 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,32 +14,19 @@ Allows adding link previews to your articles.

## Installation

### Install via NPM

Get the package

```shell
npm i --save-dev @editorjs/link
yarn add @editorjs/link
```

Include module at your application

```javascript
const LinkTool = require('@editorjs/link');
import LinkTool from '@editorjs/link';
```

### Download to your project's source dir

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

### Load from CDN

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

`https://cdn.jsdelivr.net/npm/@editorjs/[email protected]`

Then require this script on page with Editor.js through the `<script src=""></script>` tag.
Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/link@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/link",
"version": "2.6.1",
"version": "2.6.2",
"keywords": [
"codex editor",
"tool",
Expand Down

0 comments on commit 674068c

Please sign in to comment.