Revamp doc (#51)

* vscode setting

* revamp doc

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   "spellright.language": ["en"],
-  "spellright.documentTypes": ["markdown", "latex", "plaintext", "rust"],
+  "spellright.documentTypes": ["markdown", "latex", "plaintext", "rust", "toml"],
   "rust-analyzer.cargo.features": ["pure"],
   "rust-analyzer.cargo.noDefaultFeatures": true,
   "rust-analyzer.procMacro.enable": true,

.vscode/spellright.dict

@@ -21,3 +21,6 @@ sandybridge
 ssse
 bindgen
 NONINFRINGEMENT
+md
+typenum
+rs

README.md

@@ -12,6 +12,8 @@ ECIES functionalities are built upon AES-GCM-256 and HKDF-SHA256.
 
 This is the Rust version of [eciespy](https://github.com/ecies/py).
 
+This library can be compiled to the WASM target at your option, see [WASM compatibility](#wasm-compatibility).
+
 ## Quick Start
 
 ```rust
@@ -44,11 +46,17 @@ Pure Rust implementation is sometimes useful, such as building on WASM:
 cargo build --no-default-features --features pure --target=wasm32-unknown-unknown
 ```
 
-If you select the pure Rust backend on modern CPUs, consider building with `RUSTFLAGS="-Ctarget-cpu=sandybridge -Ctarget-feature=+aes,+sse2,+sse4.1,+ssse3"` to speed up AES encryption/decryption. This would be no longer necessary when `aes-gcm` supports automatic CPU detection.
+If you select the pure Rust backend on modern CPUs, consider building with
+
+```bash
+RUSTFLAGS="-Ctarget-cpu=sandybridge -Ctarget-feature=+aes,+sse2,+sse4.1,+ssse3"
+```
+
+to speed up AES encryption/decryption. This would be no longer necessary when [`aes-gcm` supports automatic CPU detection](https://github.com/RustCrypto/AEADs/issues/243#issuecomment-738821935).
 
 ## WASM compatibility
 
-It's also possible to build on the `wasm32-unknown-unknown` target with the pure Rust backend. Check out [this repo](https://github.com/ecies/rs-wasm) for more details.
+It's also possible to build to the `wasm32-unknown-unknown` target with the pure Rust backend. Check out [this repo](https://github.com/ecies/rs-wasm) for more details.
 
 ## Security notes
 
@@ -75,7 +83,7 @@ Following dependencies are audited:
 
 - Revamp documentations
 - Optional pure Rust AES backend
-- WASM support
+- WASM compatibility
 
 ### 0.1.1 ~ 0.1.5
 

src/lib.rs

@@ -4,6 +4,8 @@
 //!
 //! This is the Rust version of [eciespy](https://github.com/ecies/py).
 //!
+//! This library can be compiled to the WASM target at your option, see [WASM compatibility](#wasm-compatibility).
+//!
 //! # Quick Start
 //!
 //! ```rust
@@ -36,11 +38,17 @@
 //! cargo build --no-default-features --features pure --target=wasm32-unknown-unknown
 //! ```
 //!
-//! If you select the pure Rust backend on modern CPUs, consider building with `RUSTFLAGS="-Ctarget-cpu=sandybridge -Ctarget-feature=+aes,+sse2,+sse4.1,+ssse3"` to speed up AES encryption/decryption. This would be no longer necessary when `aes-gcm` supports automatic CPU detection.
+//! If you select the pure Rust backend on modern CPUs, consider building with
+//!
+//! ```bash
+//! RUSTFLAGS="-Ctarget-cpu=sandybridge -Ctarget-feature=+aes,+sse2,+sse4.1,+ssse3"
+//! ```
+//!
+//! to speed up AES encryption/decryption. This would be no longer necessary when [`aes-gcm` supports automatic CPU detection](https://github.com/RustCrypto/AEADs/issues/243#issuecomment-738821935).
 //!
 //! # WASM compatibility
 //!
-//! It's also possible to build on the `wasm32-unknown-unknown` target with the pure Rust backend. Check out [this repo](https://github.com/ecies/rs-wasm) for more details.
+//! It's also possible to build to the `wasm32-unknown-unknown` target with the pure Rust backend. Check out [this repo](https://github.com/ecies/rs-wasm) for more details.
 
 pub use secp256k1::{util::FULL_PUBLIC_KEY_SIZE, Error as SecpError, PublicKey, SecretKey};