Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheaMorin authored Apr 13, 2021
1 parent 132b687 commit 9c75f21
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Plover Plugins Registry

The list of plugins that will show in the Plover Plugins Manager.

In order for your [Plover](https://github.com/openstenoproject/plover) plugin to be installable
from the [plugins manager](https://github.com/benoit-pierre/plover_plugins_manager), it must be
listed here.

## Contributing

To add your plugin to the registry, please:

- Fork this repository
- Add your plugin to the list as it's named on [PyPI](https://pypi.org)
- Ensure that the list is an alphabetical JSON array
- Open a pull request ([how to open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request))
- After your PR is merged, the plugin will be listed in the Plover Plugins Manager

0 comments on commit 9c75f21

Please sign in to comment.