From b5375d2f216c22cf576f434fe88629b4cd4cb079 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= <sebastian@centricular.com>
Date: Tue, 29 Jun 2021 00:23:09 +0300
Subject: [PATCH] gst-plugin-version-helper: Add README.md and fix up docs

---
 version-helper/README.md  | 40 +++++++++++++++++++++++++++++++++++++++
 version-helper/src/lib.rs |  2 +-
 2 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 version-helper/README.md

diff --git a/version-helper/README.md b/version-helper/README.md
new file mode 100644
index 000000000..07a23e3ff
--- /dev/null
+++ b/version-helper/README.md
@@ -0,0 +1,40 @@
+# gst-plugin-version-helper [![crates.io](https://img.shields.io/crates/v/gst-plugin-version-helper.svg)](https://crates.io/crates/gst-plugin-version-helper) [![docs.rs](https://docs.rs/gst-plugin-version-helper/badge.svg)](https://docs.rs/gst-plugin-version-helper)
+
+Extracts release for [GStreamer](https://gstreamer.freedesktop.org) plugin metadata
+
+See the [documentation](https://docs.rs/gst-plugin-version-helper) for details.
+
+This function is supposed to be used as follows in the `build.rs` of a crate that implements a
+plugin:
+
+```rust,ignore
+gst_plugin_version_helper::get_info();
+```
+
+Inside `lib.rs` of the plugin, the information provided by `get_info` are usable as follows:
+
+```rust,ignore
+gst::plugin_define!(
+    the_plugin_name,
+    env!("CARGO_PKG_DESCRIPTION"),
+    plugin_init,
+    concat!(env!("CARGO_PKG_VERSION"), "-", env!("COMMIT_ID")),
+    "The Plugin's License",
+    env!("CARGO_PKG_NAME"),
+    env!("CARGO_PKG_NAME"),
+    env!("CARGO_PKG_REPOSITORY"),
+    env!("BUILD_REL_DATE")
+);
+
+## LICENSE
+
+`gst-plugin-version-helper` is licensed under the MIT license ([LICENSE](LICENSE) or
+http://opensource.org/licenses/MIT).
+
+## Contribution
+
+Any kinds of contributions are welcome as a pull request.
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in `gst-plugin-version-helper` by you shall be licensed
+under the MIT license as above, without any additional terms or conditions.
diff --git a/version-helper/src/lib.rs b/version-helper/src/lib.rs
index 7841c5372..0258b10e3 100644
--- a/version-helper/src/lib.rs
+++ b/version-helper/src/lib.rs
@@ -17,7 +17,7 @@
 //! Inside `lib.rs` of the plugin, the information provided by `get_info` are usable as follows:
 //!
 //! ```rust,ignore
-//! plugin_define!(
+//! gst::plugin_define!(
 //!     the_plugin_name,
 //!     env!("CARGO_PKG_DESCRIPTION"),
 //!     plugin_init,