diff --git a/README.md b/README.md index 0146597..8be58fe 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,10 @@ VSS execution is split into two phases: Phase I prioritizes recovery and single- multi-device use. Phase I is ready to use and integrated within [LDK-node]. Phase II will be subject to monitoring for demand from wallets and may slip to a later date. Refer to [LDK-Roadmap] for more details. +### API + +See the [VSS API contract] for details. + ### Implementation Currently, VSS-server has a Java-based implementation and is ready to use. Support for a Rust-based VSS-server is a work @@ -107,6 +111,8 @@ If you encounter any issues or have questions, feel free to open an issue on the [GitHub repository](https://github.com/lightningdevkit/vss-server/issues). For further assistance or to discuss the development of VSS, you can reach out to us in the [LDK Discord] in the `#vss` channel. +[VSS API contract]: https://github.com/lightningdevkit/vss-server/blob/main/proto/vss.proto + [VSS-rust-client]: https://github.com/lightningdevkit/vss-rust-client [LDK-node]: https://github.com/lightningdevkit/ldk-node