diff --git a/README.md b/README.md index a5c6784..25a9895 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ # Horoscope NuGet -A .NET library for Zodiac signs. Get details on each Zodiac sign, pass a date and know which Zodiac sign it falls in or get a list of all Zodiac signs. Currently in beta. - +A .NET library for zodiac signs. Get details on each zodiac sign, pass a date and know which zodiac sign it falls in or get a list of all zodiac signs. Now includes Chinese zodiac signs and elements! + [![NuGet](https://img.shields.io/nuget/v/Horoscope.svg)](https://www.nuget.org/packages/Horoscope/) -## Usage -Install using package manager. +## How to use +#### Installation +Library can be installed with [Nuget](https://www.nuget.org/packages/Horoscope/). +```PowerShell +PM> Install-Package Horoscope ``` -Install-Package Horoscope -Version 0.0.2 -``` - +#### Usage Include the namespace in your program. -``` +```C# using Horoscope; ``` Then go ahead and consume it. -``` +```C# var zodiacSign = Zodiac.GetZodiacSignForDate(new DateTime(1950, 2, 12)); ``` - +#### More examples +[Horoscope.Zodiac](https://github.com/ClydeDz/horoscope-nuget/blob/master/Src/Horoscope.TestConsole/ZodiacExamples.cs) +[Horoscope.ChineseZodiac](https://github.com/ClydeDz/horoscope-nuget/blob/master/Src/Horoscope.TestConsole/ChineseZodiacExamples.cs) + + +## Release notes +Find release notes [here](https://github.com/ClydeDz/horoscope-nuget/wiki#release-notes). ## Credits (c) 2018 [Clyde D'Souza](https://clydedsouza.net) diff --git a/Src/Horoscope.sln b/Src/Horoscope.sln index 0539c75..555d8aa 100644 --- a/Src/Horoscope.sln +++ b/Src/Horoscope.sln @@ -9,6 +9,13 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Horoscope.TestConsole", "Ho EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Horoscope.Tests", "Horoscope.Tests\Horoscope.Tests.csproj", "{23BC995E-393A-4E74-B74F-89FB54D2E885}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution items", "Solution items", "{DF07DAC1-0499-4D6D-8B51-36F4A623C99D}" + ProjectSection(SolutionItems) = preProject + ..\Icon.png = ..\Icon.png + ..\LICENSE = ..\LICENSE + ..\README.md = ..\README.md + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU diff --git a/Src/Horoscope/Horoscope.csproj b/Src/Horoscope/Horoscope.csproj index 903b57d..e0fab8a 100644 --- a/Src/Horoscope/Horoscope.csproj +++ b/Src/Horoscope/Horoscope.csproj @@ -5,20 +5,19 @@ Clyde D'Souza false Horoscope - 0.0.2 + 0.0.3 https://github.com/ClydeDz/horoscope-nuget/blob/master/LICENSE https://github.com/ClydeDz/horoscope-nuget https://github.com/ClydeDz/horoscope-nuget/wiki - horoscope zodiac development library zodiac-signs - A .NET library for Zodiac signs. Get details on each Zodiac sign, pass a date and know which Zodiac sign it falls in or get a list of all Zodiac signs. Currently in beta. - (c) 2018 Clyde D'Souza - 0.0.2 -Includes basic functionality to get Zodiac signs. -0.0.1 -Beta release. - 0.0.0.2 - 0.0.0.2 + horoscope zodiac development library zodiac-signs chinese-zodiac chinese-horoscope yinyang chinese-elements yin-yang + A .NET library for zodiac signs. Get details on each zodiac sign, pass a date and know which zodiac sign it falls in or get a list of all zodiac signs. Now includes Chinese zodiac signs and elements! + Copyright (c) 2018 Clyde D'Souza + Now includes Chinese zodiac signs, fixed elements (i.e., wood, fire, earth, metal, water) and yin yang associated with each Chinese zodiac sign. + +More release notes here: https://github.com/ClydeDz/horoscope-nuget/wiki#release-notes + 0.0.0.3 + 0.0.0.3 https://raw.githubusercontent.com/ClydeDz/horoscope-nuget/master/Icon.png