Update readme

JeremyAnsel · Jul 29, 2024 · f885560 · f885560
1 parent e974d41
commit f885560
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/JeremyAnsel.DirectX.D3DXof/JeremyAnsel.DirectX.D3DXof/JeremyAnsel.DirectX.D3DXof.csproj b/JeremyAnsel.DirectX.D3DXof/JeremyAnsel.DirectX.D3DXof/JeremyAnsel.DirectX.D3DXof.csproj
@@ -18,6 +18,7 @@
     <Company>Jérémy Ansel</Company>
     <Copyright>Copyright © 2020-2022 Jérémy Ansel</Copyright>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>Media 3D Model DirectX Xof</PackageTags>
     <PackageProjectUrl>https://github.com/JeremyAnsel/JeremyAnsel.DirectX.D3DXof</PackageProjectUrl>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
@@ -32,6 +33,10 @@
       <Pack>True</Pack>
       <PackagePath></PackagePath>
     </None>
+    <None Include="..\..\README.md">
+      <Pack>True</Pack>
+      <PackagePath></PackagePath>
+    </None>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/README.md b/README.md
@@ -13,3 +13,9 @@ Documentation   | http://jeremyansel.github.io/JeremyAnsel.DirectX.D3DXof
 Source code     | https://github.com/JeremyAnsel/JeremyAnsel.DirectX.D3DXof
 Nuget           | https://www.nuget.org/packages/JeremyAnsel.DirectX.D3DXof
 Build           | https://ci.appveyor.com/project/JeremyAnsel/jeremyansel-directx-d3dxof/branch/master
+
+# Usage
+
+```csharp
+XFile file = XFile.FromFile(fileName);
+```