Skip to content

Commit 0edd2e0

Browse files
committed
Add links to API docs and Noise specification
1 parent 2cdf7be commit 0edd2e0

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ java-noise supports all handshake patterns, handshake pattern modifiers, and cry
1313

1414
All other algorithms named in the Noise Protocol Framework specification are supported unconditionally.
1515

16+
## Reference
17+
18+
- [java-noise API documentation (Javadoc)](https://jchambers.github.io/java-noise/apidocs/latest/)
19+
- [The Noise Protocol Framework specification](https://noiseprotocol.org/noise.html)
20+
1621
## Handshakes
1722

1823
A Noise protocol begins with a handshake in which two parties (an initiator and a responder) exchange handshake messages that contain key material and optional payloads to negotiate a shared secret key and establish an ongoing session for Noise transport messages. Noise handshakes are described by ["handshake patterns"](https://noiseprotocol.org/noise.html#handshake-patterns), which prescribe the handshake messages exchanged between the initiator and responder. In java-noise, Noise handshakes are managed by NoiseHandshake instances.

0 commit comments

Comments
 (0)