prosemirror-suggestions/README.md

ProseMirror plugin for suggestions (i.e. mentions, tags)

# prosemirror-suggestions

A plugin for [ProseMirror](https://prosemirror.net/) that helps you add suggestions to your editor.

This package is based on [@quartzy/prosemirror-suggestions](https://github.com/quartzy/prosemirror-suggestions) by Tristan Pemble.

"Suggestions" is a loose concept; while we originally designed this plugin around `@mentions` or `#hash-tags`, we hope
that it can be adapted to other use cases.

This plugin will not render any UI for you. The goal is to handle triggers, giving you tools to render your own UI
elements however you choose.

## Installation

```bash
npm install --save prosemirror-suggestions
```

## Usage

@TODO

## Development

```bash
# Run tests
npm run test

# Build distributable
npm run build

# Build and watch for changes
npm run watch
```

## Credits

- [Johannes Wilm](https://github.com/johanneswilm)
- [Tristan Pemble](https://github.com/tristanpemble)

## License

The Apache License, v2.0. Please see [License File](LICENSE) for more information.

[ico-version]: https://img.shields.io/npm/v/@quartzy/prosemirror-suggestions.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg?style=flat-square
[ico-downloads]: https://img.shields.io/npm/dt/@quartzy/prosemirror-suggestions.svg?style=flat-square

[link-npm]: https://www.npmjs.com/package/prosemirror-suggestions
[link-downloads]: https://www.npmjs.com/package/prosemirror-suggestions