Skip to content

Commit 8e8b35e

Browse files
committed
Add LICENSE and update documents
1 parent f875714 commit 8e8b35e

File tree

4 files changed

+47
-3
lines changed

4 files changed

+47
-3
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2020 Yuku TAKAHASHI
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
11
# Textcomplete
22

33
> Autocomplete for textarea elements
4+
5+
## Packages
6+
7+
Textcomplete consists of subpackages:
8+
9+
Name | Description
10+
-----------------------|------------------------------
11+
@textcomplete/core | Core of Textcomplete.
12+
@textcomplete/textarea | Editor for Textarea elements.

packages/textcomplete-core/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# @textcomplete/core
2+
3+
> Core of Textcomplete
+15-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
1-
# textcomplete
1+
# @textcomplete/textarea
22

3-
> Autocomplete for Textarea elements.
3+
> Textcomplete editor implementation for Textarea elements.
4+
5+
## Install
46

57
```bash
6-
npm add --save textcomplete
8+
npm install --save @textcomplete/core @texttcomplete/textarea
9+
```
10+
11+
## Synopsis
12+
13+
```js
14+
const { Textcomplete } = require("@textcomplete/core")
15+
const { Textarea } = require("@textcomplete/textarea")
16+
17+
const editor = new Textarea(textareaElement)
18+
const textcomplete = new Textcomplete(editor, strategies, option)
719
```

0 commit comments

Comments
 (0)