Modify README.

Author: jmjoy

README.md

@@ -1,16 +1,116 @@
 # PHPer
 
+[![crates](https://img.shields.io/crates/v/phper?style=flat-square)](https://crates.io/crates/phper)
+[![](https://img.shields.io/docsrs/phper?style=flat-square)](https://docs.rs/phper)
+
 A library that allows us to write PHP extensions using pure Rust and using safe Rust whenever possible.
 
 ## Requirement
 
-- os: linux
-- libclang: version >= 9
-- php: version in (7.1, 7.2, 7.3, 7.4, 8.0), mode: nts
+### Necessary
+
+**libclang** version >= 9
+
+**php** version >= 7
+
+### Tested Support
+
+**os**
+
+- linux
+  
+**php**
+
+*version*
+
+- 7.0
+- 7.1
+- 7.2
+- 7.3
+- 7.4
+- 8.0
+  
+*mode*
+
+- nts
+
+*sapi*
+
+- cli
 
 ## Usage
 
-Now see [examples](examples).
+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.2"
+```
+
+4. Add these code to `main.rs`.
+
+```rust
+use phper::cmd::make;
+
+fn main() {
+    make();
+}
+```
+
+5. Write you owned extension logic in `lib.rs`.
+
+```rust
+#[php_get_module]
+pub fn get_module(module: &mut Module) {
+    // set module metadata
+    module.set_name(env!("CARGO_PKG_NAME"));
+    module.set_version(env!("CARGO_PKG_VERSION"));
+    module.set_author(env!("CARGO_PKG_AUTHORS"));
+    
+    // ...
+}
+```
+
+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](examples).
 
 ## License
 

examples/hello/README.md

@@ -0,0 +1,28 @@
+# hello
+
+Hello world example.
+
+## Environment
+
+```bash
+# Specify if php isn't installed globally.
+export PHP_CONFIG = <Your path of php-config>
+```
+
+## Build
+
+```bash
+cargo build --release
+```
+
+## Test
+
+```bash
+cargo test --release
+```
+
+## Install
+
+```bash
+cargo run --release -- install
+```

examples/hello/src/lib.rs

@@ -22,7 +22,7 @@ fn throw_exception(_: &mut [Val]) -> phper::Result<()> {
 }
 
 #[php_get_module]
-pub extern "C" fn get_module(module: &mut Module) {
+pub fn get_module(module: &mut Module) {
     // set module metadata
     module.set_name(env!("CARGO_PKG_NAME"));
     module.set_version(env!("CARGO_PKG_VERSION"));

phper/Cargo.toml

@@ -5,6 +5,7 @@ authors = ["jmjoy <[email protected]>"]
 edition = "2018"
 description = "A library that allows us to write PHP extensions using pure Rust and using safe Rust whenever possible."
 repository = "https://github.com/jmjoy/phper.git"
+documentation = "https://docs.rs/phper"
 license = "Unlicense"
 readme = "../README.md"
 keywords = ["php", "binding", "extension"]

phper/src/functions.rs

@@ -199,6 +199,7 @@ pub const fn create_zend_arg_info(
 ) -> zend_internal_arg_info {
     #[cfg(phper_php_version = "8.0")]
     {
+        use std::ptr::null_mut;
         zend_internal_arg_info {
             name,
             type_: zend_type {

phper/src/lib.rs

@@ -1,29 +1,123 @@
 #![warn(rust_2018_idioms, clippy::dbg_macro, clippy::print_stdout)]
 
 /*!
+# PHPer
+
+[![crates](https://img.shields.io/crates/v/phper?style=flat-square)](https://crates.io/crates/phper)
+[![](https://img.shields.io/docsrs/phper?style=flat-square)](https://docs.rs/phper)
+
 A library that allows us to write PHP extensions using pure Rust and using safe Rust whenever possible.
 
-***Now the peojct is still under development.***
+## Requirement
+
+### Necessary
+
+**libclang** version >= 9
+
+**php** version >= 7
+
+### Tested Support
+
+**os**
+
+- linux
+
+**php**
+
+*version*
 
-# Usage
+- 7.0
+- 7.1
+- 7.2
+- 7.3
+- 7.4
+- 8.0
+
+*mode*
+
+- nts
+
+*sapi*
+
+- cli
+
+## 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
+```
 
-First you have to install `cargo-generate`:
+2. Create you cargo project, suppose your application is called myapp.
 
 ```bash
-cargo install cargo-generate
+cargo new myapp
 ```
 
-Then create a PHP extension project from the [template](https://github.com/jmjoy/phper-ext-skel.git):
+3. Add the dependencies and metadata to you Cargo project.
+
+```toml
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+phper = "0.2"
+```
+
+4. Add these code to `main.rs`.
+
+```rust
+use phper::cmd::make;
+
+fn main() {
+    make();
+}
+```
+
+5. Write you owned extension logic in `lib.rs`.
+
+```rust
+#[php_get_module]
+pub fn get_module(module: &mut Module) {
+    // set module metadata
+    module.set_name(env!("CARGO_PKG_NAME"));
+    module.set_version(env!("CARGO_PKG_VERSION"));
+    module.set_author(env!("CARGO_PKG_AUTHORS"));
+
+    // ...
+}
+```
+
+6. Build and install, if your php isn't installed globally, you should specify the path of `php-config`.
 
 ```bash
-cargo generate --git https://github.com/jmjoy/phper-ext-skel.git
+# 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
 ```
 
-# Notice
+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).
 
-Now the library don't support `ZTS`, the template is using `thread_local!` instead.
+## License
 
-Version `0.1.x` will be a preview version.
+[Unlicense](https://github.com/jmjoy/phper/blob/master/LICENSE).
 */
 
 pub mod arrays;