Update documents.

Author: jmjoy

README.md

@@ -14,6 +14,7 @@ A library that allows us to write PHP extensions using pure Rust and using safe
 
 ### Necessary
 
+- **rust** 1.54 or later
 - **libclang** 9.0 or later
 - **php** 7.0 or later
 
@@ -99,13 +100,16 @@ pub fn get_module() -> Module {
 
 ```bash
 # Optional, specify if php isn't installed globally.
-export PHP_CONFIG = <Your path of php-config>
+export PHP_CONFIG=<Your path of php-config>
 
 # Build libmyapp.so.
 cargo build --release
 
-# Install to php extension path, if you install php globally, you should use sudo.
+# Install to php extension path.
 cargo run --release -- install
+# Or if you install php globally, you should use sudo.
+# sudo ./target/release/myapp install
+
 ```
 
 7. Edit your `php.ini`, add the below line.

examples/hello/README.md

@@ -6,7 +6,7 @@ Hello world example.
 
 ```bash
 # Optional, specify if php isn't installed globally.
-export PHP_CONFIG = <Your path of php-config>
+export PHP_CONFIG=<Your path of php-config>
 ```
 
 ## Build

examples/http-client/README.md

@@ -8,7 +8,7 @@ Power by [reqwest::blocking](https://docs.rs/reqwest/0.11.4/reqwest/blocking/ind
 
 ```bash
 # Optional, specify if php isn't installed globally.
-export PHP_CONFIG = <Your path of php-config>
+export PHP_CONFIG=<Your path of php-config>
 ```
 
 ## Build

examples/http-server/README.md

@@ -8,7 +8,7 @@ Power by [tokio](https://crates.io/crates/tokio) and [hyper](https://crates.io/c
 
 ```bash
 # Optional, specify if php isn't installed globally.
-export PHP_CONFIG = <Your path of php-config>
+export PHP_CONFIG=<Your path of php-config>
 ```
 
 ## Build

examples/logging/README.md

@@ -6,7 +6,7 @@ Log example.
 
 ```bash
 # Optional, specify if php isn't installed globally.
-export PHP_CONFIG = <Your path of php-config>
+export PHP_CONFIG=<Your path of php-config>
 ```
 
 ## Build

phper/src/lib.rs

@@ -1,93 +1,5 @@
 #![warn(rust_2018_idioms, clippy::dbg_macro, clippy::print_stdout)]
-
-/*!
-## Rust ❤️ PHP
-
-A library that allows us to write PHP extensions using pure Rust and using safe Rust whenever possible.
-
-## Usage
-
-1. Make sure `libclang` and `php` is installed.
-
-```bash
-# If you are using debian like linux system:
-sudo apt install libclang-10-dev php-cli
-```
-
-2. Create you cargo project, suppose your application is called myapp.
-
-```bash
-cargo new myapp
-```
-
-3. Add the dependencies and metadata to you Cargo project.
-
-```toml
-[lib]
-crate-type = ["cdylib"]
-
-[dependencies]
-phper = "0.3"
-```
-
-4. Add these code to `main.rs`.
-
-```no_run
-use phper::cmd::make;
-
-fn main() {
-    make();
-}
-```
-
-5. Write you owned extension logic in `lib.rs`.
-
-```no_run
-use phper::{php_get_module, modules::Module};
-
-#[php_get_module]
-pub fn get_module() -> Module {
-    let mut module = Module::new(
-        env!("CARGO_PKG_NAME"),
-        env!("CARGO_PKG_VERSION"),
-        env!("CARGO_PKG_AUTHORS"),
-    );
-
-    // ...
-
-    module
-}
-```
-
-6. Build and install, if your php isn't installed globally, you should specify the path of `php-config`.
-
-```bash
-# Specify if php isn't installed globally.
-export PHP_CONFIG = <Your path of php-config>
-
-# Build libmyapp.so.
-cargo build --release
-
-# Install to php extension path, if you install php globally, you should use sudo.
-cargo run --release -- install
-```
-
-7. Edit your `php.ini`, add the below line.
-
-```ini
-extension = myapp
-```
-
-8. Enjoy.
-
-## examples
-
-See [examples](https://github.com/jmjoy/phper/tree/master/examples).
-
-## License
-
-[Unlicense](https://github.com/jmjoy/phper/blob/master/LICENSE).
-*/
+#![doc = include_str!("../README.md")]
 
 #[macro_use]
 mod macros;