45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
|
<!--
|
||
|
|
NOTE: This template is for the English version (README.md).
|
||
|
|
The Chinese version (README_CN.md) MUST be translated based on this English version to ensure consistency in structure and content.
|
||
|
|
-->
|
||
|
|
# [Plugin Name] [Optional Emoji]
|
||
|
|
|
||
|
|
[Brief description of what the plugin does. Keep it concise and engaging.]
|
||
|
|
|
||
|
|
**Author:** [Fu-Jie](https://github.com/Fu-Jie) | **Version:** 1.0.0 | **Project:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) | **License:** MIT
|
||
|
|
|
||
|
|
## What's New
|
||
|
|
|
||
|
|
<!-- Keep the changelog for the last 3 versions here. Remove this section for the initial release. -->
|
||
|
|
|
||
|
|
### v1.0.0
|
||
|
|
- **Initial Release**: Released the first version of the plugin.
|
||
|
|
- **[Feature Name]**: [Brief description of the feature].
|
||
|
|
|
||
|
|
## Key Features 🔑
|
||
|
|
|
||
|
|
- **[Feature 1]**: [Description of feature 1].
|
||
|
|
- **[Feature 2]**: [Description of feature 2].
|
||
|
|
- **[Feature 3]**: [Description of feature 3].
|
||
|
|
|
||
|
|
## How to Use 🛠️
|
||
|
|
|
||
|
|
1. **Install**: Add the plugin to your OpenWebUI instance.
|
||
|
|
2. **Configure**: Adjust settings in the Valves menu (optional).
|
||
|
|
3. **[Action Step]**: Describe how to trigger or use the plugin.
|
||
|
|
4. **[Result Step]**: Describe the expected outcome.
|
||
|
|
|
||
|
|
## Configuration (Valves) ⚙️
|
||
|
|
|
||
|
|
| Valve | Default | Description |
|
||
|
|
|-------|---------|-------------|
|
||
|
|
| `VALVE_NAME` | `Default Value` | Description of what this setting does. |
|
||
|
|
| `ANOTHER_VALVE` | `True` | Another setting description. |
|
||
|
|
|
||
|
|
## Troubleshooting ❓
|
||
|
|
|
||
|
|
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
|
||
|
|
- **Debug Logs**: Enable `SHOW_DEBUG_LOG` in Valves and check the browser console (F12) for detailed logs.
|
||
|
|
- **Error Messages**: If you see an error, please copy the full error message and report it.
|
||
|
|
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
|