add readme

whistyun · Jan 10, 2023 · a3788fa · a3788fa
1 parent f65a43d
commit a3788fa
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 0 deletions.
diff --git a/MdXaml.Html/MdXaml.Html.csproj b/MdXaml.Html/MdXaml.Html.csproj
@@ -9,6 +9,7 @@
     <Copyright>© Simon Baynes 2013; whistyun 2022</Copyright>
     <PackageProjectUrl>https://github.com/whistyun/MdXaml</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReadmeFile>MdXaml.Html.md</PackageReadmeFile>
     <PackageTags>Markdown WPF Xaml FlowDocument</PackageTags>
     <Configurations>Debug;Release</Configurations>
 
@@ -20,6 +21,11 @@
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>..\key.snk</AssemblyOriginatorKeyFile>
   </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="..\pack_readme\MdXaml.Html.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
 	  <None Remove="Core\Parsers\TypicalBlockParser.tsv" />
 	  <None Remove="Core\Parsers\TypicalInlineParser.tsv" />

diff --git a/MdXaml.Svg/MdXaml.Svg.csproj b/MdXaml.Svg/MdXaml.Svg.csproj
@@ -10,6 +10,7 @@
     <Copyright>Copyright (c) 2022 whistyun</Copyright>
     <PackageProjectUrl>https://github.com/whistyun/MdXaml</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReadmeFile>MdXaml.Svg.md</PackageReadmeFile>
     <PackageTags>Markdown WPF Xaml FlowDocument</PackageTags>
     <Configurations>Debug;Release</Configurations>
 
@@ -22,6 +23,10 @@
     <AssemblyOriginatorKeyFile>..\key.snk</AssemblyOriginatorKeyFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\pack_readme\MdXaml.Svg.md" Pack="true" PackagePath="\"/>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Svg" Version="3.0.84" />
   </ItemGroup>

diff --git a/MdXaml/MdXaml.csproj b/MdXaml/MdXaml.csproj
@@ -11,6 +11,7 @@
     <Copyright>Copyright (c) 2010 Bevan Arps, 2020 whistyun</Copyright>
     <PackageProjectUrl>https://github.com/whistyun/MdXaml</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageReadmeFile>MdXaml.md</PackageReadmeFile>
     <PackageTags>Markdown WPF Xaml FlowDocument</PackageTags>
     <Configurations>Debug;Release</Configurations>
     <LangVersion>9</LangVersion>
@@ -24,6 +25,7 @@
   <ItemGroup>
     <None Remove="EmojiTable.txt" />
     <EmbeddedResource Include="EmojiTable.txt" />
+    <None Include="..\pack_readme\MdXaml.md" Pack="true" PackagePath="\"/>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/pack_readme/MdXaml.Html.md b/pack_readme/MdXaml.Html.md
@@ -0,0 +1 @@
+A plugin for converting HTML to FlowDocument in MdXaml
diff --git a/pack_readme/MdXaml.Svg.md b/pack_readme/MdXaml.Svg.md
@@ -0,0 +1 @@
+A plugin for rendering SVG in MdXaml
diff --git a/pack_readme/MdXaml.md b/pack_readme/MdXaml.md
@@ -0,0 +1,17 @@
+Transform Markdown to FlowDocument(WPF).
+
+**How to use**  
+[How to transform markdown to FlowDocument-object.](https://whistyun.github.io/MdXaml/transform_markdow_to_flowdocument.html)  
+[How to render markdown in WPF Control.](https://whistyun.github.io/MdXaml/render_markdown_in_control.html)  
+[for more](https://github.com/whistyun/MdXaml/wiki)
+
+**Migration from Markdown.Xaml**  
+MdXaml change namespace from Markdown.Xaml to MdXaml. So you should change namespace in your code.
+Or use [migration free edition](https://www.nuget.org/packages/MdXaml_migfree/)
+
+**Preview**  
+![sc1](https://raw.githubusercontent.com/whistyun/MdXaml/master/docs/img.demo/sc1.png)
+![sc2](https://raw.githubusercontent.com/whistyun/MdXaml/master/docs/img.demo/sc2.png)
+![sc3](https://raw.githubusercontent.com/whistyun/MdXaml/master/docs/img.demo/sc3.png)
+![sc4](https://raw.githubusercontent.com/whistyun/MdXaml/master/docs/img.demo/sc4.png)
+![sc5](https://raw.githubusercontent.com/whistyun/MdXaml/master/docs/img.demo/sc5.png)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		A plugin for converting HTML to FlowDocument in MdXaml