From 4ddfec572760dddd5b2258c40250ed1e0a07940e Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 16:11:12 +1300 Subject: [PATCH 1/8] Update version and add tags --- src/GiveMeAnAvatar/GiveMeAnAvatar.csproj | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj b/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj index 910b9af..27d5cc8 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,8 @@ 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. + 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 From 616e43c3b91b2928263a923ce80a3ad4dead1e85 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 16:18:42 +1300 Subject: [PATCH 2/8] Update badges and icon URL in the readme file --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ca7e26e..0060061 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,12 +8,17 @@ # 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 +PM> Install-Package GiveMeAnAvatar ``` Include the namespace in your program. @@ -40,7 +45,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=invalidate-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 +68,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 From c1b1d725d837b6c69a6d098f09fe0047a87fb644 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 16:19:21 +1300 Subject: [PATCH 3/8] Add ignore folder to the gitignore list --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) 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 From e52c3c54916787f177c7e41a6561874f0dd513a1 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 16:21:53 +1300 Subject: [PATCH 4/8] Update PR template with namespace information --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) 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. From 6b47c575f1cc889fdc46d44ebc7db032b9777886 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 16:47:07 +1300 Subject: [PATCH 5/8] Remove using statement from usage guide since thats not required --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 0060061..a0e033b 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,7 @@ Command to install Give Me an Avatar NuGet via the Package Manager Console UI in PM> Install-Package GiveMeAnAvatar ``` -Include the namespace in your program. -```C# -using GiveMeAnAvatar; -``` - -Then go ahead and consume it. +Go ahead and consume it directly. ```C# var avatarURL= GiveMeAnAvatar.GetAvatarURL(); ``` From 0a0d2f2397e6d67438a9433284f2af2c580ac83d Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 16:50:04 +1300 Subject: [PATCH 6/8] Try a different query string parameter to fix broken image URL --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0e033b..e285f9a 100644 --- a/README.md +++ b/README.md @@ -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-nuget) | +| [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/) | From 4dcb9ef14935ace1ad7a26f37d594caaf1c89a43 Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 17:03:58 +1300 Subject: [PATCH 7/8] Convert main class to static --- src/GiveMeAnAvatar/GiveMeAnAvatar.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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. From 4c8c1db5569b5c2ec8ea84b333451cc7216694ec Mon Sep 17 00:00:00 2001 From: Clyde D'Souza Date: Tue, 22 Dec 2020 17:04:30 +1300 Subject: [PATCH 8/8] Generate documentation files The summary comments aren't showing up in the consumer app so adding this. --- src/GiveMeAnAvatar/GiveMeAnAvatar.csproj | 1 + 1 file changed, 1 insertion(+) diff --git a/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj b/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj index 27d5cc8..c0f12d3 100644 --- a/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj +++ b/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj @@ -13,6 +13,7 @@ https://github.com/ClydeDz/give-me-an-avatar-nuget Icon.jpg 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