Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nicola-corbellini committed Aug 5, 2023
1 parent 4a7159e commit b5e43f0
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
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.

0 comments on commit b5e43f0

Please sign in to comment.