Skip to content

Commit

Permalink
Adding documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
david-dick authored and oalders committed Sep 5, 2024
1 parent 3f42f04 commit 15d3594
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -632,6 +632,13 @@ generic methods.

See _news_ scheme and [RFC 5538](https://tools.ietf.org/html/rfc5538).

- **otpauth**:

The _otpauth_ URI scheme is specified in [https://github.com/google/google-authenticator/wiki/Key-Uri-Format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format).
The scheme is used to encode secret keys for use in TOTP or HOTP schemes.

`URI` objects belonging to the otpauth scheme support the common methods.

- **pop**:

The _pop_ URI scheme is specified in RFC 2384. The scheme is used to
Expand Down
7 changes: 7 additions & 0 deletions lib/URI.pm
Original file line number Diff line number Diff line change
Expand Up @@ -1087,6 +1087,13 @@ See I<news> scheme.
See I<news> scheme and L<RFC 5538|https://tools.ietf.org/html/rfc5538>.
=item B<otpauth>:
The I<otpauth> URI scheme is specified in L<https://github.com/google/google-authenticator/wiki/Key-Uri-Format>.
The scheme is used to encode secret keys for use in TOTP or HOTP schemes.
C<URI> objects belonging to the otpauth scheme support the common methods.
=item B<pop>:
The I<pop> URI scheme is specified in RFC 2384. The scheme is used to
Expand Down

0 comments on commit 15d3594

Please sign in to comment.