diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5088b41..a2ac4e0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,6 +12,7 @@ - [ ] My change requires a change to the documentation in the `README` file. - [ ] I have updated the documentation in the `README` file accordingly. - [ ] I have updated the version number in the [`GiveMeAnAvatar.csproj`](https://github.com/ClydeDz/give-me-an-avatar-nuget/blob/main/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj) file using the [SemVer](https://semver.org/) format. +- [ ] If I've added a class/method/any other object for public consumption, it is in the GiveMeAnAvatar namespace , i.e. `namespace GiveMeAnAvatar`. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. diff --git a/.gitignore b/.gitignore index dfcfd56..6cb5e33 100644 --- a/.gitignore +++ b/.gitignore @@ -348,3 +348,5 @@ MigrationBackup/ # Ionide (cross platform F# VS Code tools) working folder .ionide/ + +ignore/ \ No newline at end of file diff --git a/README.md b/README.md index ca7e26e..e285f9a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- Give me an avatar npm package icon + Give me an avatar NuGet package icon

@@ -8,20 +8,20 @@ # Give Me an Avatar Gets a random avatar URL from a collection of different avatar generation services. +[![Azure DevOps builds](https://img.shields.io/azure-devops/build/clydedsouza-nuget/03b052e2-ef54-44b2-82b3-3c3a1e09d864/10?logo=Azure%20DevOps)](https://dev.azure.com/clydedsouza-nuget/Give%20Me%20an%20Avatar%20NuGet/_build) +[![Azure DevOps tests](https://img.shields.io/azure-devops/tests/clydedsouza-nuget/Give%2520Me%2520an%2520Avatar%2520NuGet/10?logo=Azure%20DevOps)](https://dev.azure.com/clydedsouza-nuget/Give%20Me%20an%20Avatar%20NuGet/_build) +[![Nuget](https://img.shields.io/nuget/v/GiveMeAnAvatar?color=brightgreen&logo=NuGet)](https://www.nuget.org/packages/GiveMeAnAvatar) +[![Nuget](https://img.shields.io/nuget/dt/GiveMeAnAvatar?color=brightgreen&logo=NuGet)](https://www.nuget.org/packages/GiveMeAnAvatar) + ## Installation and usage -Library can either be directly downloaded from [Nuget.org](https://www.nuget.org/packages/give-me-an-avatar/), OR installed via the [NuGet Package Manager UI](https://docs.microsoft.com/en-us/nuget/tools/package-manager-ui#finding-and-installing-a-package) or via the [Package Manager Console](https://docs.microsoft.com/en-us/nuget/tools/package-manager-console) if you're using Visual Studio. +Library can either be directly downloaded from [Nuget.org](https://www.nuget.org/packages/GiveMeAnAvatar), OR installed via the [NuGet Package Manager UI](https://docs.microsoft.com/en-us/nuget/tools/package-manager-ui#finding-and-installing-a-package) or via the [Package Manager Console](https://docs.microsoft.com/en-us/nuget/tools/package-manager-console) if you're using Visual Studio. Command to install Give Me an Avatar NuGet via the Package Manager Console UI in Visual Studio shown below. ```PowerShell -PM> Install-Package give-me-an-avatar -``` - -Include the namespace in your program. -```C# -using GiveMeAnAvatar; +PM> Install-Package GiveMeAnAvatar ``` -Then go ahead and consume it. +Go ahead and consume it directly. ```C# var avatarURL= GiveMeAnAvatar.GetAvatarURL(); ``` @@ -40,7 +40,7 @@ var avatarURL= GiveMeAnAvatar.GetAvatarURL(settings); |--------------------------------------------|------------------------------------------------------| | [placeholder.com](https://placeholder.com) | ![image](https://via.placeholder.com/128?Text=J%20S) | | [placeimg.com](https://placeimg.com) | ![image](https://placeimg.com/128/128/people) | -| [placekitten.com](https://placekitten.com) | ![image](https://placekitten.com/g/128/128?cache=invalidate) | +| [placekitten.com](https://placekitten.com) | ![image](https://placekitten.com/g/128/128?cache=nuget) | | [dummyimage.com](https://dummyimage.com/) | ![image](https://dummyimage.com/128x128&text=J%20S) | | [loremflickr.com](https://loremflickr.com) | ![image](https://loremflickr.com/128/128/human) | | [baconmockup.com](https://baconmockup.com) | ![image](https://baconmockup.com/128/128/) | @@ -63,6 +63,6 @@ var avatarURL= GiveMeAnAvatar.GetAvatarURL(settings); * Placekitten image might appear broken at times in the table above, however, the image service itself runs fine. ## Credits -- All the avatar services used in this npm package are outlined in the table above. +- All the avatar services used in this NuGet package are outlined in the table above. - Package logo created using [AutoDraw](https://www.autodraw.com/). -- This NPM package is developed by [Clyde D'Souza](https://twitter.com/clydedz). \ No newline at end of file +- This NuGet package is developed by [Clyde D'Souza](https://twitter.com/clydedz). \ No newline at end of file diff --git a/src/GiveMeAnAvatar/GiveMeAnAvatar.cs b/src/GiveMeAnAvatar/GiveMeAnAvatar.cs index 48652c2..015e627 100644 --- a/src/GiveMeAnAvatar/GiveMeAnAvatar.cs +++ b/src/GiveMeAnAvatar/GiveMeAnAvatar.cs @@ -5,7 +5,7 @@ namespace GiveMeAnAvatar /// /// Service to return a random avatar URL from a collection of different avatar generation services. /// - public class GiveMeAnAvatar + public static class GiveMeAnAvatar { /// /// Returns the URL of an avatar that is picked at random. diff --git a/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj b/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj index 910b9af..c0f12d3 100644 --- a/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj +++ b/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj @@ -3,7 +3,7 @@ netstandard2.0;net5.0 true - 0.1.0 + 0.2.0 Gets a random avatar URL from a collection of different avatar generation services. Clyde D'Souza Give Me an Avatar @@ -12,8 +12,9 @@ https://github.com/ClydeDz/give-me-an-avatar-nuget https://github.com/ClydeDz/give-me-an-avatar-nuget Icon.jpg - Development release - avatar avatar-generator avatar-library random-avatar + Development release. + true + avatar avatar-generator avatar-library random-avatar mock-avatars gravatar placeholder-image identicon robohash thispersondoesnotexist human-avatars pixel-art-avatar ui-avatar picsum dummyimage avataaar uimaterial-avatars jdenticon