diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9cf7545 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,34 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [0.2.0] - 2024-05-28 + +### Added + +- **Python Usage Section**: Detailed instructions on how to use ScrAIbe with Python, including examples for Whisper models, WhisperX, and keyword arguments. +- **Command-line Usage Section**: Enhanced instructions for using ScrAIbe via the command-line interface, including examples and key options. +- **Documentation Section**: Expanded the documentation section with highlights on installation guides, usage examples, API reference, troubleshooting tips, and advanced configuration. +- **Getting Started Section**: Added detailed prerequisites and installation instructions for both stable and development versions of ScrAIbe. +- **WhisperX Support**: Added support for the WhisperX backend. + +### Changed + +- **Model Customization**: Clarified the use of various keywords to customize Whisper models, Pyannote diarization models, and WhisperX. +- **Example Enhancements**: Improved examples to illustrate the usage of different features and options in ScrAIbe. +- **Formatting and Clarity**: Improved formatting and clarity across all sections to enhance readability and user experience. +- **Backend Robustness**: Enhanced the backend to be more robust, removing the need for a HuggingFace token for basic usage. +- **CLI**: to Work without Gradio + +### Removed + +- **Docker Build**: Removed Docker build support. +- **Gradio App**: Removed the Gradio App integration. + +Both the Docker Build and the Gradio App are now Available under [ScrAIbe-WebUI](https://github.com/JSchmie/ScrAIbe-WebUI) + +### Documentation + +- **Documentation Page Link**: Updated the documentation section with a direct link to the [ScrAIbe documentation page](https://jschmie.github.io/ScrAIbe/). + +**Note**: This changelog might be incomplete, but we promise to improve it in the future. Thank you for your understanding and support.