Make manual and README descriptions less ambiguous

zpuskas · Apr 9, 2018 · 2930044 · 2930044
1 parent ca3f1a8
commit 2930044
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # oath-uri
 
-oath-uri provides a library and CLI tool to generate OATH OTP key sharing URI
-for soft tokens.
+**oath-uri** is an open source C/C++ library and command line tool to generate
+OATH TOTP/HOTP key sharing URI for soft tokens, also known as one-time password
+authentication applications.
 
 When setting up two-factor authentication a secret must be shared with the user
 to set up their soft token (typically a smartphone authenticator app). This

diff --git a/man/oathuri.1 b/man/oathuri.1
@@ -1,6 +1,6 @@
 .TH OATHURI "1" "January 2018" "oathuri 1.0.0" "User Commands"
 .SH NAME
-oathuri \- Generate OATH OTP key URI for soft tokens
+oathuri \- Generate OATH TOTP/HOTP key URI for soft tokens
 .SH SYNOPSIS
 .B oathuri
 [\fI\,OPTION\/\fR...] \fI\,SECRET ACCOUNT ISSUER\/\fR

diff --git a/man/oathuri.h.3 b/man/oathuri.h.3
@@ -1,6 +1,6 @@
 .TH "oathuri_totp_generate" 3 "1.0.0" "liboathuri" "liboathuri"
 .SH NAME
-oathuri_totp_generate, oathuri_hotp_generate \- OATH OTP key URI generation
+oathuri_totp_generate, oathuri_hotp_generate \- OATH TOTP/HOTP key URI generation
 .SH SYNOPSIS
 .nf
 .B #include <oathuri.h>