summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKyle Spearrin <kspearrin@users.noreply.github.com>2017-01-28 22:03:43 -0500
committerGitHub <noreply@github.com>2017-01-28 22:03:43 -0500
commit78146f15150b0c1fd3f35fba4a2481c564a17fac (patch)
treec6796c54208b62375a3648d9512cc81b2fce2b19
parentdaf18b2f3d897562e27d8f27444405bff75e96f6 (diff)
downloadOtp.NET-78146f15150b0c1fd3f35fba4a2481c564a17fac.zip
Otp.NET-78146f15150b0c1fd3f35fba4a2481c564a17fac.tar.gz
Otp.NET-78146f15150b0c1fd3f35fba4a2481c564a17fac.tar.bz2
Update README.md
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6b6a0a5..2491c7c 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,10 @@ TOTP is an algorithm that uses a rolling window of time to calculate single use
## Creation of a TOTP object
Use of the library is fairly straightforward. There is a class called Totp. Simple create a new instance of it and pass in the shared secret key in plaintext as a byte array. There is also an overload that takes a ProtectedKey object. ProtectedKeys are encrypted in memory except for a narrow window of time where the hash is actually computed. The TOTP class converts all plaintext keys into a ProtectedKey internally.
+
+```c#
+using OtpNet;
+```
```c#
var topt = new Totp(secretKey);