hinawa: add crate README

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>

3 files changed, 50 insertions, 21 deletions

diff --git a/hinawa/Cargo.toml b/hinawa/Cargo.toml
index af19d8b..6f0286f 100644
--- a/hinawa/Cargo.toml
+++ b/hinawa/Cargo.toml
@@ -11,6 +11,7 @@ exclude = ["Gir.toml"]
 homepage = "https://alsa-project.github.io/gobject-introspection-docs/"
 keywords = ["ieee1394", "firewire", "linux", "glib"]
 license = "MIT"
+readme = "README.md"
 repository = "https://github.com/alsa-project/hinawa-rs/"
 
 [lib]
diff --git a/hinawa/README.md b/hinawa/README.md
new file mode 100644
index 0000000..434df3c
--- /dev/null
+++ b/hinawa/README.md
@@ -0,0 +1,48 @@
+# hinawa crate
+
+Rust API bindings and wrappers for [hinawa library](https://github.com/alsa-project/libhinawa) to
+operate Linux FireWire character device for asynchronous packet and topology generation
+in IEEE 1394 bus.
+
+The hinawa library version 2.5 is the minimum supported version for underlying library.
+
+The hinawa crate is automatically generated by [gir tool](https://gtk-rs.org/gir/book/) provided
+by [gtk-rs project](https://gtk-rs.org/). Hinawa-3.0 file from hinawa library is used for the
+generation. But some functions are implemented manually.
+
+## Usage
+
+Add the following line to your Cargo.toml file:
+
+```toml
+[dependencies]
+hinawa = "0.0.90"
+```
+
+The API documentation is available in <https://docs.rs/hinawa/>.
+
+## License
+
+The hinawa crate is released under [MIT license](https://spdx.org/licenses/MIT.html).
+
+## Dependency
+
+The hinawa crate depends on API crates provided by [gtk-rs project](https://gtk-rs.org/) for
+type/object system, event loop, and dispacher.
+
+## Repository
+
+The hinawa crate is the part of ALSA project and maintained by
+[ALSA gobject-introspection team](https://alsa-project.github.io/gobject-introspection-docs/).
+The remote repository is located in <https://github.com/alsa-project/hinawa-rs/>.
+
+## Support
+
+If finding issue, please file it in <https://github.com/alsa-project/hinawa-rs/>.
+
+## Sample programs
+Some programs are available under `examples` directory.
+
+* `read-quadlet.rs`
+
+    * demonstration to read quadlet data from node in IEEE 1394 bus.
diff --git a/hinawa/src/lib.rs b/hinawa/src/lib.rs
index 335070a..411c886 100644
--- a/hinawa/src/lib.rs
+++ b/hinawa/src/lib.rs
@@ -1,26 +1,6 @@
 // SPDX-License-Identifier: MIT
 
-//! Rust bindings for hinawa library
-//!
-//! Rust bindings and wrappers for [hinawa library](https://github.com/alsa-project/libhinawa) to
-//! operate Linux FireWire character device for asynchronous packet and topology generation in
-//! IEEE 1394 bus.
-//!
-//! The hinawa library v2.5.0 is the minimum supported version for underlying library.
-//!
-//! The crate depends on [glib crate v0.15](https://crates.io/crates/glib) provided by
-//! [gtk-rs project](https://gtk-rs.org/) for type/object system, event loop, and dispacher.
-//!
-//! # License
-//!
-//! Released under MIT license.
-//!
-//! # Sample programs
-//!
-//! Some programs are available under `examples` directory.
-//!
-//! `read-quadlet`
-//! : demonstration to read quadlet data from node in IEEE 1394 bus.
+#![doc = include_str!("../README.md")]
 
 mod auto;
 mod fw_fcp;