Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nicola-corbellini authored Nov 24, 2023
1 parent bd157d1 commit a272e58
Showing 1 changed file with 14 additions and 23 deletions.
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
# Catube
# Ingest Anyhing

[![awesome plugin](https://custom-icon-badges.demolab.com/static/v1?label=&message=awesome+plugin&color=383938&style=for-the-badge&logo=cheshire_cat_ai)](https://)
[![Awesome plugin](https://custom-icon-badges.demolab.com/static/v1?label=&message=Awesome+plugin&color=000000&style=for-the-badge&logo=cheshire_cat_ai)](https://)
[![awesome plugin](https://custom-icon-badges.demolab.com/static/v1?label=&message=awesome+plugin&color=F4F4F5&style=for-the-badge&logo=cheshire_cat_black)](https://)

Write here all the useful information about your plugin.

This repository is the template to automate the release of official Cheshire Cat AI plugins.

## Usage

1. Create a new repository clicking on the `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` in the `plugin.json` file.
> Please, remember to set it correctly every time to want to release an update.

This plugin allows extending the Rabbit Hole's supported file formats.
Currently, available formats are:
- `.csv`;
- `.xlsx`;
- `.py`;
- `.js`;
- `.docx`;
- `.doc`;
- `.json`

## Requests and Contributions
Please, if you would like some file type to be supported open an issue.
Pull requests to extend the list further are welcome!

0 comments on commit a272e58

Please sign in to comment.