Merge pull request #36 from varshard/fix-typos

fix some obvious typos

README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-RustyVault is a modern secret management system, written in Rust. RustyVault provides various features which support many scenarios including secure sotrage, cloud identity management, secret management, Kubernetes integration, PKI infrastructure, cryptographic computing, traditional key management, etc.
+RustyVault is a modern secret management system, written in Rust. RustyVault provides various features which support many scenarios including secure storage, cloud identity management, secret management, Kubernetes integration, PKI infrastructure, cryptographic computing, traditional key management, etc.
 
 RustyVault can be deployed in either cloud or physical environments. Depending on different requirements, RustyVault may run as standalone application with a set of RESTful APIs provided, and it can also be used as a crate thus you can easily integrate it into your own Rust application.
 
@@ -12,7 +12,7 @@ One of the goals of RustyVault is to replace Hashicorp Vault seamlessly if you a
 
 ## Feature
 
-Part of the features provided by Rustyvault are as follows:
+Part of the features provided by RustyVault are as follows:
 
 * Working Mode
   * standalone process w/HTTP APIs
@@ -58,4 +58,4 @@ Part of the features provided by Rustyvault are as follows:
 
 ## Design
 
-Read the [design](.\/design.md) document.
+Read the [design](./design.md) document.

design.md

@@ -1,6 +1,6 @@
 # RustyVault Design
 
-As per: [RustyVault Requirements Document](.\/req-en.md). In this document we describe the architecture of RustyVault.
+As per: [RustyVault Requirements Document](./req.md). In this document we describe the architecture of RustyVault.
 
 # Architecture Diagram
 
@@ -15,6 +15,6 @@ Detailed description:
 
 2. RustyVault depends on cryptography libraries (or cryptographic modules) to have the functionality such as encryption, signing, TLS connections and etc. Depending on the configuration, the cryptography library may be various, including native Rust crypto crates (ring, Rustls...), OpenSSL (via rust-openssl), Tongsuo...
 
-3. RustyVault is able to utilize many different cryptography hardware, such as HSMs or cryptography cards. But RustyVault doesn't talk to these hardware equipments directly, instead the underlying cryptography library sits between them and makes it more easy for RustyVault to reach the hardware ability.
+3. RustyVault is able to utilize many different cryptographic hardware, such as HSMs or cryptography cards. But RustyVault doesn't talk to these hardware equipments directly, instead the underlying cryptography library sits between them and makes it easier for RustyVault to reach the hardware ability.
 
-4. The sesitive data in RustyVault (such as secrets, credentials, password, keys...) can be stored in local storage or an external remote storage such as etcd. The external storage is necessary if RustyVault runs in cluster. Different storage method is managed by the Storage Manager in the RustyVault Core component. Thanks to this design, other modules of RustyVault don't need to deal with different types of storage.
+4. The sensitive data in RustyVault (such as secrets, credentials, password, keys...) can be stored in local storage or an external remote storage such as etcd. The external storage is necessary if RustyVault runs in cluster. Different storage method is managed by the Storage Manager in the RustyVault Core component. Thanks to this design, other modules of RustyVault don't need to deal with different types of storage.

req.md

@@ -14,13 +14,13 @@ And compared to Hashicorp Vault, there is rare open source key/secret management
 
 The new project needs to fulfill most features the a traditional KMS has. It also needs to be a replacement for Hashicorp Vault, with the features that even are not included in the open source versions of Vault. As such, the new project should be:
 
-0. Written in Rust to achieve memory safe
-0. Fully compatible with Hashicorp Vault on APIs and data format
-1. Configurable underlying cryptograhpic module
-2. High performance on cryptography operations
-3. High availability
-4. Support for underlying cryptography hardware
-5. OSI-approved open-source license
+1. Written in Rust to achieve memory safe
+2. Fully compatible with Hashicorp Vault on APIs and data format
+3. Configurable underlying cryptographic module
+4. High performance on cryptography operations
+5. High availability
+6. Support for underlying cryptography hardware
+7. OSI-approved open-source license
 
 # Requirements List
 
@@ -54,7 +54,7 @@ Features:
       * Signature: RSA/ECDSA/EdDSA/SM2/Ring Signature
       * Encryption: RSA/SM2
   * Digest: SHA1/SHA2/SM3
-* Advanced Cryptography Algorihtm
+* Advanced Cryptography Algorithm
   * PHE: Paillier, EC-ElGamal
   * ZKP: Bulletproofs
   * Post Quantum Cryptography