Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.freedesktop.org/gstreamer/gst-plugins-rs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian@centricular.com>2017-12-22 16:56:48 +0300
committerSebastian Dröge <sebastian@centricular.com>2017-12-22 16:56:48 +0300
commit2decd553d79dfdaabed91f90c25c872cecab923e (patch)
tree697e2f5a16ea8ecc35f7873e592b035a26df800c /README.md
parent723409e05a1bb3a2a302bf9396c835f0c63a7837 (diff)
Update README.md and include it in the gst-plugin crate too
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 24 insertions, 7 deletions
diff --git a/README.md b/README.md
index ed04912f4..ee19d8ecc 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,27 @@
-# gst-plugin-rs [![Build Status](https://travis-ci.org/sdroege/gst-plugin-rs.svg?branch=master)](https://travis-ci.org/sdroege/gst-plugin-rs)
-
-[GStreamer](https://gstreamer.freedesktop.org/) elements built in the [Rust programming language](https://www.rust-lang.org/).
-
-For background and motivation, see the [announcement blogpost](https://coaxion.net/blog/2016/05/writing-gstreamer-plugins-and-elements-in-rust/) and the follow-up blogposts [1](https://coaxion.net/blog/2016/09/writing-gstreamer-elements-in-rust-part-2-dont-panic-we-have-better-assertions-now-and-other-updates/), [2](https://coaxion.net/blog/2016/11/writing-gstreamer-elements-in-rust-part-3-parsing-data-from-untrusted-sources-like-its-2016/), [3](https://coaxion.net/blog/2017/03/writing-gstreamer-elements-in-rust-part-4-logging-cows-and-plugins/).
-
-Application-side bindings for GStreamer can be found here: https://github.com/sdroege/gstreamer-rs
+# gst-plugin-rs [![crates.io](https://img.shields.io/crates/v/gst-plugin.svg)](https://crates.io/crates/gst-plugin) [![Build Status](https://travis-ci.org/sdroege/gst-plugin-rs.svg?branch=master)](https://travis-ci.org/sdroege/gst-plugin-rs)
+
+Infrastructure for writing [GStreamer](https://gstreamer.freedesktop.org/)
+plugins and elements in the [Rust programming
+language](https://www.rust-lang.org/), and a collection of various GStreamer
+plugins.
+
+Documentation for the crate containing the infrastructure for writing
+GStreamer plugins in Rust, [`gst-plugin`](gst-plugin), can be found
+[here](https://sdroege.github.io/rustdoc/gst-plugin/gst_plugin/). The whole
+API builds upon the [application-side GStreamer bindings](https://github.com/sdroege/gstreamer-rs).
+Check the README.md of that repository also for details about how to set-up
+your development environment.
+
+Various example plugins can be found in the [GIT repository](https://github.com/sdroege/gst-plugin-rs/).
+
+For background and motivation, see the [announcement
+blogpost](https://coaxion.net/blog/2016/05/writing-gstreamer-plugins-and-elements-in-rust/)
+and the follow-up blogposts
+[1](https://coaxion.net/blog/2016/09/writing-gstreamer-elements-in-rust-part-2-dont-panic-we-have-better-assertions-now-and-other-updates/),
+[2](https://coaxion.net/blog/2016/11/writing-gstreamer-elements-in-rust-part-3-parsing-data-from-untrusted-sources-like-its-2016/),
+[3](https://coaxion.net/blog/2017/03/writing-gstreamer-elements-in-rust-part-4-logging-cows-and-plugins/).
+Note that the overall implementation has changed completely since those
+blogposts were written.
## LICENSE