From 1ec81cd013be01ae3942d51f75cacab183062e06 Mon Sep 17 00:00:00 2001 From: Andrei Date: Thu, 17 Jul 2025 00:00:00 +0000 Subject: [PATCH] Fix typos in readme files --- README.md | 23 +++++++++++------------ rust/README.md | 10 +++++----- 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8be58fe..4f21461 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ anyone as a Versioned Storage Service. It offers two core functionalities:

-Clients can also use VSS for general metadata storage as well such as payment history, user metadata etc. +Clients can also use VSS for general metadata storage such as payment history, user metadata, etc. ### Motivation @@ -37,18 +37,18 @@ data-integrity mechanisms. It even allows for the disabling of versioning altoge making it simple to get started. The project's design decisions prioritize features such as multi-device access, user privacy through client-side -encryption(e.g. using key derived from bitcoin wallet), authorization mechanisms, data and version number verifiability, +encryption (e.g. using key derived from bitcoin wallet), authorization mechanisms, data and version number verifiability, and modularity for seamless integration with different backend technologies. ### Modularity -VSS can work out-of-box with minor configuration but is intended to be forked and customized based on the specific needs +VSS can work out-of-the-box with minor configuration but is intended to be forked and customized based on the specific needs of wallet developers. This customization may include implementing custom authorization, encryption, or backend database integration with different cloud providers. As long as the API contract is implemented correctly, wallets can effortlessly switch between different instances of VSS. -VSS ships with a PostgreSQL implementation by default and can be hosted in your favorite infrastructure/cloud provider ( -AWS/GCP) and its backend storage can be switched with some other implementation for KeyValueStore if needed. +VSS ships with a PostgreSQL implementation by default and can be hosted in your favorite infrastructure/cloud provider +(AWS/GCP) and its backend storage can be switched with some other implementation for KeyValueStore if needed. ### Project Status @@ -70,7 +70,7 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support. ### Development -* **Build & Deploy**: Refer to language specific folder for instructions related to build and deploy of VSS. +* **Build & Deploy**: Refer to language-specific folder for instructions related to building and deploying VSS. * **Hosting**: VSS can either be self-hosted or deployed in the cloud. If a service provider is hosting VSS for multiple users, it must be configured with **HTTPS**, **Authentication/Authorization**, and **rate-limiting**. * **Authentication and Authorization**: Currently, the VSS-server @@ -86,12 +86,11 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support. ```rust use ldk_node::Builder; fn main() { - let mut node_builder = Builder::new(); - ... - let node = node_builder.build_with_vss_store_and_fixed_headers(vss_endpoint, store_id, HashMap::new()).unwrap(); - node.start().unwrap(); - ... - ... + let mut node_builder = Builder::new(); + ... + let node = node_builder.build_with_vss_store_and_fixed_headers(vss_endpoint, store_id, HashMap::new()).unwrap(); + node.start().unwrap(); + ... } ``` * **Using with Other Applications**: VSS is designed to store application-related metadata. Clients can use diff --git a/rust/README.md b/rust/README.md index a66727b..7b9b96c 100644 --- a/rust/README.md +++ b/rust/README.md @@ -21,14 +21,14 @@ cargo build --release environment variables as needed. Add PostgreSQL endpoint configuration. 2. Create table in PostgreSQL using `./impls/src/postgres/sql/` 3. Start server: - ``` - cargo run -- server/vss-server-config.toml - ``` -3. VSS endpoint should be reachable at `http://localhost:8080/vss`. + ``` + cargo run -- server/vss-server-config.toml + ``` +4. VSS endpoint should be reachable at `http://localhost:8080/vss`. ### Configuration -Refer `./server/vss-server-config.toml` to see available configuration options. +Refer to `./server/vss-server-config.toml` to see available configuration options. ### Support