Merge pull request #7 from FRACerqueira/developer

Review Key features

NugetREADME.md

@@ -1,4 +1,4 @@
-# **Welcome to RingBufferPlus**
+# **Welcome to RingBufferPlus**
 
 ### **RingBufferPlus A generic circular buffer (ring buffer) in C# with Auto-Scaler, and Report-Metrics.**
 
@@ -22,10 +22,13 @@ The implementation follows the basic principle. The principle was expanded to ha
 - Set unique name for same buffer type
 - Set the buffer capacity
 - Set the minimum and maximum capacity (optional)
-- Set the conditions for scaling to maximum and minimum
-- Associate the logger inertface
-- Define a user role for generated errors
-- Define a user role to receive capacity change events
+    - Set the conditions for scaling to maximum and minimum (required)
+        - Automatic condition values ​​based on capacity (value not required)
+    - Define a user role to receive capacity change events (optional)
+- Associate the logger interface (optional)
+- Define a user role for generated errors (optional)
+- Invalidate the buffer when it is in an invalid state
+- Warm up to full capacity before starting application 
 - Simple and clear fluent syntax
 
 ## Installing
@@ -186,7 +189,7 @@ My thanks for your great work of bringing knowledge to the community!
 
 **API documentation generated by**
 
-- [xmldoc2md](https://github.com/FRACerqueira/xmldoc2md), Copyright (c) 2022 Charles de Vandière.
+- [xmldoc2md](https://github.com/FRACerqueira/xmldoc2md), Copyright (c) 2022 Charles de Vandière.
 
 ## License
 

README.md

@@ -52,10 +52,13 @@ The implementation follows the basic principle. The principle was expanded to ha
 - Set unique name for same buffer type
 - Set the buffer capacity
 - Set the minimum and maximum capacity (optional)
-- Set the conditions for scaling to maximum and minimum
-- Associate the logger inertface
-- Define a user role for generated errors
-- Define a user role to receive capacity change events
+    - Set the conditions for scaling to maximum and minimum (required)
+        - Automatic condition values ​​based on capacity (value not required)
+    - Define a user role to receive capacity change events (optional)
+- Associate the logger interface (optional)
+- Define a user role for generated errors (optional)
+- Invalidate the buffer when it is in an invalid state
+- Warm up to full capacity before starting application 
 - Simple and clear fluent syntax
 
 ## Installing

README.txt

@@ -20,10 +20,13 @@ Features
 - Set unique name for same buffer type
 - Set the buffer capacity
 - Set the minimum and maximum capacity (optional)
-- Set the conditions for scaling to maximum and minimum
-- Associate the logger inertface
-- Define a user role for generated errors
-- Define a user role to receive capacity change events
+    - Set the conditions for scaling to maximum and minimum (required)
+        - Automatic condition values ​​based on capacity (value not required)
+    - Define a user role to receive capacity change events (optional)
+- Associate the logger interface (optional)
+- Define a user role for generated errors (optional)
+- Invalidate the buffer when it is in an invalid state
+- Warm up to full capacity before starting application 
 - Simple and clear fluent syntax
 
 Visit the official page for more documentation : 

docs/index.md

@@ -48,10 +48,13 @@ The implementation follows the basic principle. The principle was expanded to ha
 - Set unique name for same buffer type
 - Set the buffer capacity
 - Set the minimum and maximum capacity (optional)
-- Set the conditions for scaling to maximum and minimum
-- Associate the logger inertface
-- Define a user role for generated errors
-- Define a user role to receive capacity change events
+    - Set the conditions for scaling to maximum and minimum (required)
+        - Automatic condition values ​​based on capacity (value not required)
+    - Define a user role to receive capacity change events (optional)
+- Associate the logger interface (optional)
+- Define a user role for generated errors (optional)
+- Invalidate the buffer when it is in an invalid state
+- Warm up to full capacity before starting application 
 - Simple and clear fluent syntax
 
 ## Installing