Skip to content

Commit

Permalink
Add docs link to README
Browse files Browse the repository at this point in the history
  • Loading branch information
adanski committed Dec 5, 2023
1 parent 332ff67 commit 4655c66
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 14 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Textcomplete

> Autocomplete for HTMLTextAreaElement and more.
Autocomplete for HTMLTextAreaElement and more.

![Publish](https://github.com/yuku/textcomplete/workflows/Publish/badge.svg)
![Test](https://github.com/yuku/textcomplete/workflows/Test/badge.svg)
![GitHub pages](https://github.com/yuku/textcomplete/workflows/GitHub%20pages/badge.svg)

![](./docs/images/demo.gif)

[Document](https://yuku.takahashi.coffee/textcomplete/).
See more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)

## Packages

Textcomplete consists of subpackages:

Name | Description
------------------------------|-------------------------------------------
@textcomplete/core | Core of Textcomplete.
@textcomplete/textarea | Editor for HTMLTextAreaElement.
@textcomplete/contenteditable | Editor for contenteditable. (Experimental)
@textcomplete/codemirror | Editor for CodeMirror. (Experimental)
@textcomplete/utils | Utility functions for editors.
| Name | Description |
|-------------------------------|--------------------------------------------|
| @textcomplete/core | Core of Textcomplete. |
| @textcomplete/textarea | Editor for HTMLTextAreaElement. |
| @textcomplete/contenteditable | Editor for contenteditable. (Experimental) |
| @textcomplete/codemirror | Editor for CodeMirror. (Experimental) |
| @textcomplete/utils | Utility functions for editors. |

## Development

Expand Down
4 changes: 3 additions & 1 deletion packages/textcomplete-codemirror/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# @textcomplete/codemirror

> Textcomplete editor for CodeMirror. (Experimental)
Textcomplete editor for CodeMirror. (Experimental)

[![npm version](https://badge.fury.io/js/@textcomplete%2Fcodemirror.svg)](http://badge.fury.io/js/@textcomplete%2Fcodemirror)

Read more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)

## Install

```bash
Expand Down
3 changes: 2 additions & 1 deletion packages/textcomplete-contenteditable/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# @textcomplete/contenteditable

> Textcomplete editor for contenteditable. (Experimental)
Textcomplete editor for contenteditable. (Experimental)

[![npm version](https://badge.fury.io/js/@textcomplete%2Fcontenteditable.svg)](http://badge.fury.io/js/@textcomplete%2Fcontenteditable)

Read more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)

## Install

Expand Down
4 changes: 3 additions & 1 deletion packages/textcomplete-core/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# @textcomplete/core

> Core of Textcomplete
Core of Textcomplete

[![npm version](https://badge.fury.io/js/@textcomplete%2Fcore.svg)](http://badge.fury.io/js/@textcomplete%2Fcore)

Read more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)

## License

© Yuku Takahashi - This software is licensed under the MIT license.
4 changes: 3 additions & 1 deletion packages/textcomplete-textarea/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# @textcomplete/textarea

> Textcomplete editor for HTMLTextAreaElement.
Textcomplete editor for HTMLTextAreaElement.

[![npm version](https://badge.fury.io/js/@textcomplete%2Ftextarea.svg)](http://badge.fury.io/js/@textcomplete%2Ftextarea)

Read more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)

## Install

```bash
Expand Down
4 changes: 3 additions & 1 deletion packages/textcomplete-utils/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# @textcomplete/utils

> Utility functions for Textcomplete editors.
Utility functions for Textcomplete editors.

[![npm version](https://badge.fury.io/js/@textcomplete%2Futils.svg)](http://badge.fury.io/js/@textcomplete%2Futils)

Read more at [yuku.takahashi.coffee/textcomplete](https://yuku.takahashi.coffee/textcomplete/)

## License

© Yuku Takahashi - This software is licensed under the MIT license.

0 comments on commit 4655c66

Please sign in to comment.