@@ -64,13 +64,14 @@ See the [VSS API contract] for details.
6464### Implementation
6565
6666VSS has a Rust-based implementation and is ready to use.
67- [ VSS-rust- client] is a Rust-based client with support for client-side encryption, key obfuscation, retry mechanisms, and
67+ [ VSS-client] is a Rust-based client with support for client-side encryption, key obfuscation, retry mechanisms, and
6868LNURL-auth.
6969VSS is also integrated with [ LDK-node] v0.4.x as alpha support.
7070
7171### Development
7272
73- * ** Build & Deploy** : Refer to language-specific folder for instructions related to building and deploying VSS.
73+ * ** Build & Deploy** : Refer to [ docs/getting-started.md] ( docs/getting-started.md ) for instructions related to
74+ building and deploying VSS.
7475* ** Hosting** : VSS can either be self-hosted or deployed in the cloud. If a service provider is hosting VSS for multiple
7576 users, it must be configured with ** HTTPS** , ** Authentication/Authorization** , and ** rate-limiting** .
7677* ** Authentication and Authorization** : VSS supports authentication via
@@ -80,7 +81,7 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support.
8081* ** Scaling** : VSS itself is stateless and can be horizontally scaled easily. VSS can be configured to point to a
8182 PostgreSQL cluster, and further scaling considerations need to be addressed in the PostgreSQL cluster.
8283* ** Using with LDK-node** : [ LDK-node] can be easily configured to run with VSS as primary storage. It is integrated in
83- LDK-node (written in Rust) using [ VSS-rust- client] , and there is also support for other languages such as Swift,
84+ LDK-node (written in Rust) using [ VSS-client] , and there is also support for other languages such as Swift,
8485 Kotlin and Python through [ UniFFI] bindings.
8586 ``` rust
8687 use ldk_node :: Builder ;
@@ -93,7 +94,7 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support.
9394 }
9495 ```
9596* * * Using with Other Applications ** : VSS is designed to store application - related metadata . Clients can use
96- the [VSS - rust - client] directly for this purpose. This can help provide a complete user data recovery solution for
97+ the [VSS - client] directly for this purpose. This can help provide a complete user data recovery solution for
9798 applications, as well as enable turn- key multi- device support in the future.
9899
99100### Authentication
@@ -126,7 +127,7 @@ development of VSS, you can reach out to us in the [LDK Discord] in the `#vss` c
126127
127128[VSS API contract ]: https : // github.com/lightningdevkit/vss-server/blob/main/proto/vss.proto
128129
129- [VSS - rust - client ]: https : // github.com/lightningdevkit/vss-rust -client
130+ [VSS - client ]: https : // github.com/lightningdevkit/vss-client
130131
131132[LDK - node ]: https : // github.com/lightningdevkit/ldk-node
132133
0 commit comments