Add license

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zephrynis & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,21 @@
-# blueprint-build
+<!-- START BLUEPRINT-MANAGED README -->
-GH Action to build a blueprint addon
+
+> [!IMPORTANT]
+> This project is an unofficial project hosted on the [`blueprint-community`](https://github.com/blueprint-community) GitHub organization.
+> [Blueprint](https://blueprint.zip) does not create, endorse or maintain these projects.
+>
+> You are free to contribute, fork and reuse sections of this codebase [in accordance with this projects' license](LICENSE).
+
+<br>
+
+<h2 align="center"> Blueprint Export Action </h2>
+<p align="center"> This GitHub Action can be used to export the source code of a blueprint addon to a .blueprint file </p>
+
+<br>
+
+<!-- END BLUEPRINT-MANAGED README -->
+
+## How to Use
+The action has one output, FILE. This can be used in a workflow with the following variable: `${{ steps.blueprint_build.outputs.FILE }}`
+
+An example of this in use can be found [here](https://github.com/zephrynis/ptero-sidebar/blob/main/.github/workflows/export_ext.yml).

action.yml

@@ -1,8 +1,8 @@
-name: 'Blueprint Build'
+name: 'Blueprint Export'
-description: 'Builds a blueprint addon'
+description: 'Exports a blueprint addon'
 outputs:
   file:
-    description: 'The path to the built addon file'
+    description: 'The path to the exported addon file'
 runs:
   using: 'docker'
   image: 'Dockerfile'