add: README

README.md

@@ -0,0 +1,31 @@
+Polonium.Sdk
+
+**Project Description**  
+Polonium.Sdk bundles Polonium.Tasks, Polonium.Generators, and related tools into a single SDK. By referencing this SDK in your `.csproj`, you can get all Polonium build processes without manually specifying each package.
+
+**Key Features**
+- **One-Stop Integration**: A single `<Project Sdk="Polonium.Sdk/x.x.x">` line grants you the entire Polonium workflow.
+- **Version Management**: Automatically references compatible versions of Polonium libraries.
+- **Customizable**: You can override default behavior by adding or modifying `.props` and `.targets` in your project.
+
+**Installation**
+1. In your `.csproj`, replace the default SDK with Polonium.Sdk:
+   ```xml
+   <Project Sdk="Polonium.Sdk/x.x.x">
+       <!-- Your configurations -->
+   </Project>
+   ```
+2. Alternatively, add the SDK package reference:
+   ```xml
+   <PackageReference Include="Polonium.Sdk" Version="x.x.x" />
+   ```
+3. Restore packages and build your project.
+
+4. To keep godot editor from overwriting the sdk, apply Polonium.Godot.Patch
+
+**Usage Example**  
+With Polonium.Sdk, you don't need separate references for Polonium.Tasks or Polonium.Generators; everything just works out of the box.
+
+**License**  
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+