add: README

.gitignore

@@ -8,3 +8,4 @@ riderModule.iml
 /Polonium.Tasks.sln.DotSettings.user
 /VersionInfo.props
 .idea/
+/summerizer

README.md

@@ -0,0 +1,33 @@
+# Polonium.Tasks
+
+**Project Description**  
+Polonium.Tasks is a set of MSBuild tasks created to support Godot C# projects using the Polonium library. It streamlines building, cleaning, packaging, and code generation steps by automating operations around scripts, templates, and resources.
+
+**Key Features**
+- **GenerateProxyNodesTask**: Examines source directories and generates script proxies based on `[ProxyNode]` in Polonium, should not be used manually in custom project.
+- **GenerateRegistryPassThrough**: Produces bridging files for `[RegistryPassThrough]` attributes in Polonium, should not be used manually in custom project
+- **GenerateTextureSetTask**: Helps build and bundle multiple textures (e.g., button states) into a coherent set.
+- **Custom Build Workflows**: Extends typical MSBuild processes to manage Godot-specific tasks.
+
+**Installation**
+1. Add the package to your project via `.csproj`:
+   ```xml
+   <PackageReference Include="Polonium.Tasks" Version="x.x.x" />
+   ```
+2. Restore the packages and build your project.
+
+**Usage Example**
+```xml
+<Target Name="Prepare" BeforeTargets="BeforeBuild">
+    <GenerateProxyNodesTask
+        SourceDirectory="$(ProjectDir)Package/embedded/GlobalClasses"
+        TemplateDirectory="$(ProjectDir)Package/embedded/polonium_templates"
+        AttributeName="ProxyNode"
+    />
+</Target>
+```
+When you run a build, these tasks will automatically generate or update relevant files, saving you manual overhead.
+
+**License**  
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+