summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2023-10-17 00:09:01 -0400
committerPaul Duncan <pabs@pablotron.org>2023-10-17 00:09:01 -0400
commitf3a5a0cd7ebe0741dcb8a7b38b80890c9b92ed82 (patch)
tree8c7a28060c87e4156329d45cf38bb03e4d6a4c7d
parent07277bdd258180de6c93246a38bb98c223e53358 (diff)
downloadsha3-0.5.tar.bz2
sha3-0.5.zip
README.md: add api-docs linkv0.5
-rw-r--r--README.md8
1 files 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."