Skip to content

Commit

Permalink
Added NuGet readme file to the Jdenticon-net package.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmester committed Jul 5, 2017
1 parent 5daafb4 commit 28ac0f4
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions Targets/Jdenticon.Package/Jdenticon.Package.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
<None Include="Web.config.Mvc.transform" />
</ItemGroup>
<ItemGroup>
<Content Include="ReadMe.Core.txt" />
<Content Include="ReadMe.WebApi.txt" />
<Content Include="ReadMe.WebForms.txt" />
<Content Include="ReadMe.Mvc.txt" />
Expand Down
32 changes: 32 additions & 0 deletions Targets/Jdenticon.Package/ReadMe.Core.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
***************************************************************
* JDENTICON-NET
***************************************************************

Use the Identicon class to generate an identicon:

using Jdenticon;
// ...
Identicon
.FromValue("string to hash", size: 160)
.SaveAsPng("test.png");

The save operations are implemented as extension methods so remember
to include a using for the Jdenticon namespace.

Also consider the following NuGet packages if they are relevant for
your application:

* Jdenticon.AspNet.Mvc

* Jdenticon.AspNet.WebApi

* Jdenticon.AspNet.WebForms

* Jdenticon.Gdi
If you want to render icons in a WinForms application.

* Jdenticon.Wpf

Full documentation is available at
https://dmester.github.io/jdenticon-net-docs/html/N_Jdenticon.htm

1 change: 1 addition & 0 deletions Targets/Jdenticon.Package/jdenticon-net.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,6 @@
<file src="..\..\releases\help\Jdenticon.xml" target="lib\net45\Jdenticon.xml" />
<file src="..\..\releases\help\Jdenticon.xml" target="lib\netstandard1.0\Jdenticon.xml" />
<file src="..\..\releases\help\Jdenticon.xml" target="lib\netstandard1.3\Jdenticon.xml" />
<file src="ReadMe.Core.txt" target="readme.txt" />
</files>
</package>

0 comments on commit 28ac0f4

Please sign in to comment.