Preparation for NuGet release

krnlexception · Apr 19, 2024 · 078c54d · 078c54d
1 parent 6a20bad
commit 078c54d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/TiledCSPlus/NuGet.md b/TiledCSPlus/NuGet.md
@@ -0,0 +1,15 @@
+# TiledCSPlus
+
+TiledCSPlus is an extended, and up to date fork of [TiledCS](https://github.com/TheBoneJarmer/TiledCS), a .NET library for loading Tiled maps and tilesets. Currently supports only uncompressed Base64 encoded .TMX maps and .TSX tilesets.
+
+## Planned features
+* ~~Support for Tiled 1.9 and 1.10 features.~~ Fully supported!
+* ~~Embedded tilesets~~ Done!
+* ~~Better layer arrangement (layers will be arranged in order from top to bottom, instead of current tile layers, then object layers, and image layers at the end)~~ Also done!
+* Support for more formats
+
+## Does it break compability?
+**YES**, practically every field was renamed to be in PascalCase, and few fields were combined into one property eg. `offsetX` and `offsetY` into `Vector2` `offset`. Except those few changes, API didn't change much as of now.
+
+## License
+TiledCSPlus is [licensed under MIT license](LICENSE). TiledCS, the original project, was created by [Ruben Labruyere](https://github.com/TheBoneJarmer), and it was [licensed under MIT license](LICENSE_orig).
diff --git a/TiledCSPlus/TiledCSPlus.csproj b/TiledCSPlus/TiledCSPlus.csproj
@@ -4,12 +4,18 @@
         <TargetFramework>netstandard2.1</TargetFramework>
         <LangVersion>10.0</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <Version>4.0.0</Version>
+        <Version>4.0.1</Version>
         <Authors>nolemretaW, TheBoneJarmer</Authors>
         <Description>TiledCSPlus is an up to date fork of TiledCS for loading Tiled maps and tilesets</Description>
         <RepositoryUrl>https://github.com/nolemretaWxd/TiledCSPlus</RepositoryUrl>
         <PackageTags>tiled,tmx,tsx</PackageTags>
-        <PackageReleaseNotes>Changed how tiles are parsed, added embedded tileset support, and some more minor changes</PackageReleaseNotes>
+        <PackageReleaseNotes>1.9 compability mode, modernizations and fixes</PackageReleaseNotes>
+        <PackageReadmeFile>NuGet.md</PackageReadmeFile>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
     </PropertyGroup>
 
+    <ItemGroup>
+      <None Include="NuGet.md" Pack="true" PackagePath="\" />
+    </ItemGroup>
+
 </Project>