From ca8763c6e31a8cb117cda3578d1c3517c1353832 Mon Sep 17 00:00:00 2001
From: Eugene Fox <eugene@xfox111.net>
Date: Mon, 31 May 2021 19:00:56 +0300
Subject: [PATCH] Created OTPConfiguration.GenerateConfiguration (markdown)

---
 OTPConfiguration.GenerateConfiguration.md | 27 +++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 OTPConfiguration.GenerateConfiguration.md

diff --git a/OTPConfiguration.GenerateConfiguration.md b/OTPConfiguration.GenerateConfiguration.md
new file mode 100644
index 0000000..5242cf0
--- /dev/null
+++ b/OTPConfiguration.GenerateConfiguration.md
@@ -0,0 +1,27 @@
+Namespace: `SimpleOTP.Models`
+
+Assembly: `SimpleOTP.dll`
+
+Generate a new OTP configuration to send it to client.
+```csharp
+public static OTPConfiguration GenerateConfiguration(string issuer, string accountName);
+```
+### Parameters
+`issuer` `string`
+
+Name of your application/service.
+
+`accountName` `string`
+
+Username/email of the user.
+
+### Returns
+Valid `OTPConfiguration` configuraion.
+
+### Remarks
+Default parameters for generated configuration:
+- OTP algorithm: Time-based OTP
+- Key length: 160 bit (20 characters)
+- Hashing algorithm: HMAC-SHA-1
+- OTP length: 6 digits
+- Period: 30 seconds
\ No newline at end of file