Add README.md

README.md

@@ -0,0 +1,36 @@
+# Tinyblast v1.0.0
+
+## Overview
+
+Tinyblast is a lightweight plugin designed to enhance Maya’s playblast workflow by converting uncompressed `.avi` files to compressed `.mp4` files using the efficient H.264 codec. It adds a custom button to Maya's Playblast Options window, enabling users to save playblasts in the more storage-friendly `.mp4` format, significantly reducing file sizes without sacrificing quality.
+
+## Features
+
+- **Playblast to MP4 Conversion**: Automatically converts uncompressed `.avi` playblast files generated by Maya to `.mp4` format using the H.264 (libx264) codec.
+- **Seamless Integration**: Adds a custom button to Maya's Playblast Options window for quick access to conversion options.
+- **Improved File Size Efficiency**: Compresses uncompressed `.avi` files, which Maya creates by default, into `.mp4` files with minimal quality loss, freeing up disk space and improving workflow efficiency.
+
+## Known Limitations
+
+- **Windows Only**: This release is optimized for Maya’s `.avi` file output on Windows. Future versions may extend support to other platforms and formats.
+- **Uncompressed AVI Temporary File**: Tinyblast relies on Maya’s built-in playblast function, which still generates an uncompressed `.avi` file before converting it to `.mp4`. This `.avi` file is temporary and will be deleted by Maya after a few minutes.
+
+## Installation
+
+1. Download and install Tinyblast.
+2. **Load the Plugin in Maya**:
+   - Navigate to `Windows > Settings/Preferences > Plug-in Manager`.
+   - If `Tinyblast.py` is not listed, click **Browse** and locate the `Tinyblast.py` file.
+   - Check the **Loaded** box to enable the plugin.
+   - (Optional) Check **Auto-load** to automatically load the plugin every time Maya starts.
+3. Access the Playblast Options window in Maya. A new "Tinyblast" button will now be available to convert playblasts to `.mp4`.
+
+## License
+
+This project is licensed under the GPLv3 license.
+
+It also includes FFmpeg, which is licensed under GPLv3. You can download the FFmpeg source code from [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html).
+
+## FFmpeg Usage and Legal Compliance
+
+Tinyblast uses the FFmpeg library to handle the conversion of `.avi` files to `.mp4`. FFmpeg is licensed under the GPLv3 license, and its source code is available for download at [FFmpeg Source](https://ffmpeg.org/download.html).