(GH-665) Update readme

Author: johelvisguzman

src/DotNetToolkit.Repository.Caching.Couchbase/README.md

@@ -7,3 +7,14 @@ var options = new RepositoryOptionsBuilder()
 
 var repo = new Repository<Customer>(options);
 ```
+
+# Configuration Options
+
+|Action|Description|
+|------|-----------|
+|WithUserName|The user name|
+|WithPassword|The password|
+|WithBucketName|The bucket name|
+|WithEndPoint|The host name or IP address of the server|
+|WithExpiry|Expiration time|
+|WithSerializer|The serializer|

src/DotNetToolkit.Repository.Caching.InMemory/InMemoryCacheOptions.cs

@@ -41,7 +41,7 @@ public InMemoryCacheOptions WithClock([NotNull] ISystemClock clock)
         }
 
         /// <summary>
-        /// Adds the giving system clock vaue to the options.
+        /// Adds the minimum length of time between successive scans for expired items vaue to the options.
         /// </summary>
         /// <param name="expirationScanFrequency">The minimum length of time between successive scans for expired items to be added.</param>
         public InMemoryCacheOptions WithExpirationScanFrequency([NotNull] TimeSpan expirationScanFrequency)

src/DotNetToolkit.Repository.Caching.InMemory/InMemoryCacheProvider.cs renamed to src/DotNetToolkit.Repository.Caching.InMemory/Internal/InMemoryCacheProvider.cs

@@ -1,4 +1,4 @@
-namespace DotNetToolkit.Repository.Caching.InMemory
+namespace DotNetToolkit.Repository.Caching.InMemory.Internal
 {
     using Configuration.Caching;
     using JetBrains.Annotations;

src/DotNetToolkit.Repository.Caching.InMemory/README.md

@@ -7,3 +7,11 @@ var options = new RepositoryOptionsBuilder()
 
 var repo = new Repository<Customer>(options);
 ```
+
+# Configuration Options
+
+|Action|Description|
+|------|-----------|
+|WithClock|System clock|
+|WithExpirationScanFrequency|Minimum length of time between successive scans for expired items|
+|WithExpiry|Expiration time|

src/DotNetToolkit.Repository.Caching.InMemory/RepositoryOptionsBuilderExtensions.cs

@@ -1,6 +1,7 @@
 namespace DotNetToolkit.Repository.Caching.InMemory
 {
     using Configuration.Options;
+    using Internal;
     using JetBrains.Annotations;
     using System;
     using Utility;

src/DotNetToolkit.Repository.Caching.Memcached/MemcachedCacheOptions.cs

@@ -55,7 +55,7 @@ public class MemcachedCacheOptions
         public JsonSerializerSettings SerializerSettings { get { return _serializerSettings; } }
 
         /// <summary>
-        /// Adds the giving password to the options.
+        /// Adds the giving username to the options.
         /// </summary>
         /// <param name="username">The user name to be added.</param>
         public MemcachedCacheOptions WithUserName([NotNull] string username)
@@ -79,7 +79,7 @@ public MemcachedCacheOptions WithPassword([NotNull] string password)
         /// <summary>
         /// Adds the giving endpoint to the options.
         /// </summary>
-        /// <param name="host">The host name to be added.</param>
+        /// <param name="host">The host name or IP address of the server to be added.</param>
         /// <param name="port">The port to be added.</param>
         public MemcachedCacheOptions WithEndPoint([NotNull] string host, int port)
         {
@@ -93,7 +93,7 @@ public MemcachedCacheOptions WithEndPoint([NotNull] string host, int port)
         /// <summary>
         /// Adds the giving endpoint to the options.
         /// </summary>
-        /// <param name="hostAndPort">The host and port to be added.</param>
+        /// <param name="hostAndPort">The address and the port of the server in the format 'host:port' to be added.</param>
         public MemcachedCacheOptions WithEndPoint([NotNull] string hostAndPort)
         {
             _host = Guard.NotEmpty(hostAndPort, nameof(hostAndPort));
@@ -137,7 +137,6 @@ public MemcachedCacheOptions WithExpiry([NotNull] TimeSpan expiry)
         /// Adds the giving json serializer settings to the options.
         /// </summary>
         /// <param name="serializerSettings">The json srialzer settings to be added.</param>
-        /// <returns>The new options instance with the given json serializer settings added.</returns>
         public MemcachedCacheOptions WithJsonSerializerSettings([NotNull] JsonSerializerSettings serializerSettings)
         {
             _serializerSettings = Guard.NotNull(serializerSettings, nameof(serializerSettings));

src/DotNetToolkit.Repository.Caching.Memcached/README.md

@@ -7,3 +7,15 @@ var options = new RepositoryOptionsBuilder()
 
 var repo = new Repository<Customer>(options);
 ```
+
+# Configuration Options
+
+|Action|Description|
+|------|-----------|
+|WithUserName|The user name|
+|WithPassword|The password|
+|WithEndPoint|The host name or IP address of the server|
+|WithProtocal|The protocal|
+|WithAuthType|The authentication type|
+|WithExpiry|Expiration time|
+|WithJsonSerializerSettings|The json serializer settings|

src/DotNetToolkit.Repository.Caching.Redis/README.md

@@ -7,3 +7,16 @@ var options = new RepositoryOptionsBuilder()
 
 var repo = new Repository<Customer>(options);
 ```
+
+# Configuration Options
+
+|Action|Description|
+|------|-----------|
+|WithUserName|The user name|
+|WithPassword|The password|
+|WithSsl|Specifies that SSL encryption should be used|
+|WithEndPoint|The host name or IP address of the server|
+|WithAllowAdmin|Indicates whether admin operations should be allowed|
+|WithDefaultDatabase|Specifies the default database to be used when calling ConnectionMultiplexer.GetDatabase() without any parameters|
+|WithExpiry|Expiration time|
+|WithJsonSerializerSettings|The json serializer settings|

src/DotNetToolkit.Repository.Caching.Redis/RedisCacheOptions.cs

@@ -60,7 +60,7 @@ public class RedisCacheOptions
         public JsonSerializerSettings SerializerSettings {  get { return _serializerSettings; } }
 
         /// <summary>
-        /// Adds the giving password to the options.
+        /// Adds the giving username to the options.
         /// </summary>
         /// <param name="username">The user name to be added.</param>
         public RedisCacheOptions WithUserName([NotNull] string username)
@@ -84,7 +84,7 @@ public RedisCacheOptions WithPassword([NotNull] string password)
         /// <summary>
         /// Adds the giving endpoint to the options.
         /// </summary>
-        /// <param name="host">The host name to be added.</param>
+        /// <param name="host">The host name or IP address of the server to be added.</param>
         /// <param name="port">The port to be added.</param>
         public RedisCacheOptions WithEndPoint([NotNull] string host, int port)
         {
@@ -98,7 +98,7 @@ public RedisCacheOptions WithEndPoint([NotNull] string host, int port)
         /// <summary>
         /// Adds the giving endpoint to the options.
         /// </summary>
-        /// <param name="hostAndPort">The host and port to be added.</param>
+        /// <param name="hostAndPort">The address and the port of the server in the format 'host:port' to be added.</param>
         public RedisCacheOptions WithEndPoint([NotNull] string hostAndPort)
         {
             _host = Guard.NotEmpty(hostAndPort, nameof(hostAndPort));