Skip to content

Commit 848103c

Browse files
committed
Update docs
1 parent 881a017 commit 848103c

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Low level core cryptographic components for Kotlin Multiplatform
2525
NOTE: For Jvm, `Digest` extends `java.security.MessageDigest` and `Mac` extends `javax.crypto.Mac`
2626
for interoperability.
2727

28+
### Modules
29+
30+
- [core](library/core/README.md)
31+
- [digest](library/digest/README.md)
32+
- [mac](library/mac/README.md)
33+
- [xof](library/xof/README.md)
34+
35+
### API Docs
36+
37+
- [https://core.kotlincrypto.org][url-docs]
38+
2839
### Library Authors
2940

3041
Modules in `core` are intentionally **single purpose** and **small** such that you
@@ -46,12 +57,6 @@ class FooFeatureA(digest: Digest) {
4657
}
4758
```
4859

49-
### Usage
50-
51-
- See module [digest](library/digest/README.md)
52-
- See module [mac](library/mac/README.md)
53-
- See module [xof](library/xof/README.md)
54-
5560
### Get Started
5661

5762
The best way to keep `KotlinCrypto` dependencies up to date is by using the
@@ -98,3 +103,4 @@ dependencies {
98103
[url-license]: https://www.apache.org/licenses/LICENSE-2.0.txt
99104
[url-kotlin]: https://kotlinlang.org
100105
[url-version-catalog]: https://github.com/KotlinCrypto/version-catalog
106+
[url-docs]: https://core.kotlincrypto.org

0 commit comments

Comments
 (0)