Merge pull request #4 from ClydeDz/dev/0.3.0

Add a constructor to settings class so it generates documentation on the consumer's side.
ClydeDz · Dec 22, 2020 · 9820d26 · 9820d26
2 parents 6b3d36c + d15b30b
commit 9820d26
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git 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=nuget)          |
+| [placekitten.com](https://placekitten.com) | ![image](https://placekitten.com/g/128/128?usage=readme)          |
 | [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/)           |

diff --git a/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj b/src/GiveMeAnAvatar/GiveMeAnAvatar.csproj
@@ -3,10 +3,11 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net5.0</TargetFrameworks>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Version>0.2.0</Version>
+    <Version>0.3.0</Version>
     <Description>Gets a random avatar URL from a collection of different avatar generation services.</Description>
     <Authors>Clyde D'Souza</Authors>
     <Product>Give Me an Avatar</Product>
+    <Title>Give Me an Avatar</Title>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Copyright>Copyright (c) 2020 Clyde D'Souza</Copyright>
     <PackageProjectUrl>https://github.com/ClydeDz/give-me-an-avatar-nuget</PackageProjectUrl>

diff --git a/src/GiveMeAnAvatar/Model/AvatarSettings.cs b/src/GiveMeAnAvatar/Model/AvatarSettings.cs
@@ -9,6 +9,11 @@ public class AvatarSettings
         private int? _size;
         private string _extraFilter;
 
+        /// <summary>
+        /// Use these avatar settings to customize your avatar a bit.
+        /// </summary>
+        public AvatarSettings() { }
+
         /// <summary>
         /// (Optional) Some avatars display user initials or even the full name and if this setting isn't supplied, 
         /// the program randomly decides a user initial. Feel free to supply a value if you need to