diff --git a/OTPSevice.md b/OTPSevice.md new file mode 100644 index 0000000..7d41ad1 --- /dev/null +++ b/OTPSevice.md @@ -0,0 +1,19 @@ +Namespace: `SimpleOTP` + +Assembly: `SimpleOTP.dll` + +Service class for generating and validating OTP codes. +```csharp +public static class OTPService +``` + +## Examples +See `OTPService` usage examples on [Code generation/validation](https://github.com/XFox111/SimpleOTP/wiki/Code-generation-or-validation) + +## Methods +| Method | Description | +| --- | --- | +| [GenerateCode](https://github.com/XFox111/SimpleOTP/wiki/OTPServiceGenerateCode) | Generates a new OTP code with provided configuration. | +| [ValidateHotp](https://github.com/XFox111/SimpleOTP/wiki/OTPServiceValidateHotp) | Validates provided HOTP code with provided parameters. | +| [ValidateTotp](https://github.com/XFox111/SimpleOTP/wiki/OTPServiceValidateTotp) | Validates provided TOTP code with provided parameters. | +| [ValidateCode](https://github.com/XFox111/SimpleOTP/wiki/OTPServiceValidateCode) | Obsolete. Validates provided OTP code with provided parameters. | \ No newline at end of file