From f3a5a0cd7ebe0741dcb8a7b38b80890c9b92ed82 Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Tue, 17 Oct 2023 00:09:01 -0400 Subject: README.md: add api-docs link --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e4c3405..1e74ab4 100644 --- a/README.md +++ b/README.md @@ -179,9 +179,9 @@ To use this library in your application: ## Documentation -Full [API][] documentation is available in the comments of `sha3.h`. If -you have [Doxygen][] installed, you can generate [HTML][]-formatted -[API][] documentation by typing `make doc`. +Full [API][] documentation is available online [here][api-docs] and in +the comments of `sha3.h`. If you have [Doxygen][] installed, you can +generate [HTML][]-formatted [API][] documentation by typing `make doc`. ## Tests @@ -268,3 +268,5 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "LLVM compiler front end." [mit-0]: https://opensource.org/license/mit-0/ "MIT No Attribution license" +[api-docs]: https://pmdn.org/api-docs/sha3/ + "sha3 API documentation." -- cgit v1.2.3