-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4a7159e
commit b5e43f0
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
# My plugin | ||
|
||
Write here all the useful informations about your plugin. | ||
|
||
This repository is the template to automate the official the Cheshire Cat AI plugins. | ||
|
||
## Usage | ||
|
||
1. Create a new repository clicking on the green `Use this template` button. | ||
2. Clone your new repo directly in the Cat's `plugins` folder. | ||
3. Run the `setup.py` script: | ||
```bash | ||
python setup.py | ||
``` | ||
The script will prompt you to write the name of your plugin and make an initial setup setting the name in the files. | ||
4. Start developing! | ||
|
||
> **Important** | ||
> A new release of your plugin is triggered every time you set a new `version` of your plugin in the `plugin.json` file. | ||
> Please, remember to set it correctly every time to want to release an update. | ||