summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKyle Spearrin <kspearrin@users.noreply.github.com>2018-02-12 14:27:15 -0500
committerGitHub <noreply@github.com>2018-02-12 14:27:15 -0500
commit2795de28690d69a3411ae23c6b0e00ea59b0f959 (patch)
treedd9c7809019d29cb447e32ab04a19f47f2fa49b5 /README.md
parentaf055746f29bb7203a01efc6b5ffc9acf8be7cb8 (diff)
downloadOtp.NET-master.zip
Otp.NET-master.tar.gz
Otp.NET-master.tar.bz2
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/README.md b/README.md
index 665d280..69e5bff 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,6 @@
An implementation TOTP [RFC 6238](http://tools.ietf.org/html/rfc6238) and HOTP [RFC 4226](http://tools.ietf.org/html/rfc4226) in C#. This is a port of the [OtpSharp library](https://bitbucket.org/devinmartin/otp-sharp/overview) to support .NET Core.
-**TOC**
-
-- [Get it on NuGet](#get-it-on-nuget)
-- [TOTP (Timed One Time Password)](#totp-timed-one-time-password)
-- [HOTP (HMAC-based One Time Password)](#hotp-hmac-based-one-time-password)
-- [Base32 Encoding](#base32-encoding)
-
## Get it on NuGet
https://www.nuget.org/packages/Otp.NET
@@ -17,6 +10,12 @@ https://www.nuget.org/packages/Otp.NET
PM> Install-Package Otp.NET
```
+## Documentation
+
+- [TOTP (Timed One Time Password)](#totp-timed-one-time-password)
+- [HOTP (HMAC-based One Time Password)](#hotp-hmac-based-one-time-password)
+- [Base32 Encoding](#base32-encoding)
+
## TOTP (Timed One Time Password)
TOTP is an algorithm that uses a rolling window of time to calculate single use passwords. It is often used for two factor authentication. The Google Authenticator app uses TOTP to calculate one time passwords. This library implements TOTP code calculation in C#. This could be embedded in a mobile app using Mono, or used server side to simply validate codes that are provided.