diff --git a/API-reference.md b/API-reference.md index ea9f784..48afdee 100644 --- a/API-reference.md +++ b/API-reference.md @@ -1,6 +1,30 @@ +## Namespaces | Namespace | Description | | --------- | ----------- | -| [SimpleOTP](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP) | Main namespace with [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) and [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) classes | -| [SimpleOTP.Models](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP.Models) | Namespace with data object models | -| [SimpleOTP.Enums](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP.Enums) | Namespace with type enumerations | -| [SimpleOTP.Helpers](https://github.com/XFox111/SimpleOTP/wiki/SimpleOTP.Helpers) | Namespace with supplementary service classes | \ No newline at end of file +| [SimpleOTP](#SimpleOTP) | Main namespace with [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) and [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) classes | +| [SimpleOTP.Models](#SimpleOTP.Models) | Namespace with data object models | +| [SimpleOTP.Enums](#SimpleOTP.Enums) | Namespace with type enumerations | +| [SimpleOTP.Helpers](#SimpleOTP.Helpers) | Namespace with supplementary service classes | + +## SimpleOTP +| Class | Description | +| ----- | ----------- | +| [OTPService](https://github.com/XFox111/SimpleOTP/wiki/OTPService) | Service class for generating and validating OTP codes. | +| [OTPFactory](https://github.com/XFox111/SimpleOTP/wiki/OTPFactory) | Class used to streamline OTP code generation on client devices. | + +## SimpleOTP.Models +| Class | Description | +| ----- | ----------- | +| [OTPCode](https://github.com/XFox111/SimpleOTP/wiki/OTPCode) | OTP code object model. | +| [OTPConfiguration](https://github.com/XFox111/SimpleOTP/wiki/OTPConfiguration) | OTP generator configuration object. | + +## SimpleOTP.Enums +| Class | Description | +| ----- | ----------- | +| [Algorithm](https://github.com/XFox111/SimpleOTP/wiki/Algorithm) | Available OTP encryption algorithms. | +| [OTPType](https://github.com/XFox111/SimpleOTP/wiki/OTPType) | OTP algorithm types. | + +## SimpleOTP.Helpers +| Class | Description | +| ----- | ----------- | +| [SecretGenerator](https://github.com/XFox111/SimpleOTP/wiki/SecretGenerator) | Helper class for OTP secret generation. | \ No newline at end of file