From c23f5576ee5c9bd9bed8db69560391f047d723a1 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Sun, 25 Nov 2018 14:20:15 +1300 Subject: [PATCH] Updated Readme With more details and usage. --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a6ddd4..a5c6784 100644 --- a/README.md +++ b/README.md @@ -1 +1,27 @@ -# horoscope-nuget \ No newline at end of file +# 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. + +[![NuGet](https://img.shields.io/nuget/v/Horoscope.svg)](https://www.nuget.org/packages/Horoscope/) + + +## Usage +Install using package manager. +``` +Install-Package Horoscope -Version 0.0.2 +``` + +Include the namespace in your program. +``` +using Horoscope; +``` + +Then go ahead and consume it. +``` +var zodiacSign = Zodiac.GetZodiacSignForDate(new DateTime(1950, 2, 12)); +``` + + + +## Credits +(c) 2018 [Clyde D'Souza](https://clydedsouza.net) +Icon credits: [Firkin](https://openclipart.org/detail/297192/bold-zodiac-symbols-colour)