-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #86 from editor-js/update/readme
The Readme.md updated
- Loading branch information
Showing
2 changed files
with
4 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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", | ||
|