Skip to content

Commit d0d95f5

Browse files
author
i.shuvalov
committed
Added npm
1 parent 0a016f6 commit d0d95f5

File tree

3 files changed

+34
-7
lines changed

3 files changed

+34
-7
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 CodeX
3+
Copyright (c) 2024 Igor Shuvalov «VolgaIgor»
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ Allows to add an extended annotation to any text
88
- Editor.js v2.20+
99

1010
## Installation
11+
### Install via NPM
12+
Get the package
13+
14+
```shell
15+
$ npm i editorjs-annotation
16+
```
17+
18+
Include module at your application
19+
20+
```javascript
21+
import Annotation from 'editorjs-annotation';
22+
```
23+
24+
### Load from CDN
25+
26+
You can load a specific version of the package from jsDelivr CDN.
27+
28+
Require this script on a page with Editor.js.
29+
30+
```html
31+
<script src="https://cdn.jsdelivr.net/npm/editorjs-annotation"></script>
32+
```
1133

1234
### Download to your project's source dir
1335
1. Upload folder `dist` from repository

package.json

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "editorjs-annotation",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"keywords": [
55
"codex editor",
66
"annotation",
@@ -10,15 +10,16 @@
1010
],
1111
"description": "Annotation Inline Tool for Editor.js",
1212
"license": "MIT",
13-
"repository": "https://github.com/VolgaIgor/editorjs-annotation",
13+
"repository": {
14+
"type": "git",
15+
"url": "git+https://github.com/VolgaIgor/editorjs-annotation.git"
16+
},
1417
"main": "./dist/bundle.js",
1518
"scripts": {
1619
"build": "webpack --mode production",
1720
"build:dev": "webpack --mode development --watch"
1821
},
19-
"author": {
20-
"name": "Igor Shuvalov «VolgaIgor»"
21-
},
22+
"author": "Igor Shuvalov «VolgaIgor»",
2223
"devDependencies": {
2324
"@babel/core": "^7.3.4",
2425
"@babel/preset-env": "^7.3.4",
@@ -28,5 +29,9 @@
2829
"style-loader": "^0.21.0",
2930
"webpack": "^4.29.5",
3031
"webpack-cli": "^3.2.3"
31-
}
32+
},
33+
"bugs": {
34+
"url": "https://github.com/VolgaIgor/editorjs-annotation/issues"
35+
},
36+
"homepage": "https://github.com/VolgaIgor/editorjs-annotation#readme"
3237
}

0 commit comments

Comments
 (0)