Skip to content

Commit 1ec81cd

Browse files
committed
Fix typos in readme files
1 parent 02ed8e5 commit 1ec81cd

File tree

2 files changed

+16
-17
lines changed

2 files changed

+16
-17
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ anyone as a Versioned Storage Service. It offers two core functionalities:
2424
<img src="http://www.plantuml.com/plantuml/png/VP2nJWCn44HxVyMKK4JqAQ8W8aGHA33GBxuXP-7p7lRUeVmzAz60X6YcsQTvezrtasRBL89bAyHBZBZBfn57hYmuY0bkYtw6SA-lkV30DITkTd1mY-l5HbRBIInhnIC_5dOBVjliVl9RT9ru8Ou_wJlhPGX5TSQRDhYddJ7BUV8cT8-hniIySlZJ-JmFOiJn0JUZrCg2Q6BybaRJ9YVwCjCff_zWUE7lZN59YRq7rY7iFVmhNm00" />
2525
</p>
2626

27-
Clients can also use VSS for general metadata storage as well such as payment history, user metadata etc.
27+
Clients can also use VSS for general metadata storage such as payment history, user metadata, etc.
2828

2929
### Motivation
3030

@@ -37,18 +37,18 @@ data-integrity mechanisms. It even allows for the disabling of versioning altoge
3737
making it simple to get started.
3838

3939
The project's design decisions prioritize features such as multi-device access, user privacy through client-side
40-
encryption(e.g. using key derived from bitcoin wallet), authorization mechanisms, data and version number verifiability,
40+
encryption (e.g. using key derived from bitcoin wallet), authorization mechanisms, data and version number verifiability,
4141
and modularity for seamless integration with different backend technologies.
4242

4343
### Modularity
4444

45-
VSS can work out-of-box with minor configuration but is intended to be forked and customized based on the specific needs
45+
VSS can work out-of-the-box with minor configuration but is intended to be forked and customized based on the specific needs
4646
of wallet developers. This customization may include implementing custom authorization, encryption, or backend database
4747
integration with different cloud providers. As long as the API contract is implemented correctly, wallets can
4848
effortlessly switch between different instances of VSS.
4949

50-
VSS ships with a PostgreSQL implementation by default and can be hosted in your favorite infrastructure/cloud provider (
51-
AWS/GCP) and its backend storage can be switched with some other implementation for KeyValueStore if needed.
50+
VSS ships with a PostgreSQL implementation by default and can be hosted in your favorite infrastructure/cloud provider
51+
(AWS/GCP) and its backend storage can be switched with some other implementation for KeyValueStore if needed.
5252

5353
### Project Status
5454

@@ -70,7 +70,7 @@ VSS 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 build and deploy of VSS.
73+
* **Build & Deploy**: Refer to language-specific folder for instructions related to building and deploying VSS.
7474
* **Hosting**: VSS can either be self-hosted or deployed in the cloud. If a service provider is hosting VSS for multiple
7575
users, it must be configured with **HTTPS**, **Authentication/Authorization**, and **rate-limiting**.
7676
* **Authentication and Authorization**: Currently, the VSS-server
@@ -86,12 +86,11 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support.
8686
```rust
8787
use ldk_node::Builder;
8888
fn main() {
89-
let mut node_builder = Builder::new();
90-
...
91-
let node = node_builder.build_with_vss_store_and_fixed_headers(vss_endpoint, store_id, HashMap::new()).unwrap();
92-
node.start().unwrap();
93-
...
94-
...
89+
let mut node_builder = Builder::new();
90+
...
91+
let node = node_builder.build_with_vss_store_and_fixed_headers(vss_endpoint, store_id, HashMap::new()).unwrap();
92+
node.start().unwrap();
93+
...
9594
}
9695
```
9796
* **Using with Other Applications**: VSS is designed to store application-related metadata. Clients can use

rust/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ cargo build --release
2121
environment variables as needed. Add PostgreSQL endpoint configuration.
2222
2. Create table in PostgreSQL using `./impls/src/postgres/sql/`
2323
3. Start server:
24-
```
25-
cargo run -- server/vss-server-config.toml
26-
```
27-
3. VSS endpoint should be reachable at `http://localhost:8080/vss`.
24+
```
25+
cargo run -- server/vss-server-config.toml
26+
```
27+
4. VSS endpoint should be reachable at `http://localhost:8080/vss`.
2828

2929
### Configuration
3030

31-
Refer `./server/vss-server-config.toml` to see available configuration options.
31+
Refer to `./server/vss-server-config.toml` to see available configuration options.
3232

3333
### Support
3434

0 commit comments

Comments
 (0)