Introduce dedicated README files for the two crates

Our README is not particularly telling in its current form and it being
shared between libbpf-rs and libbpf-cargo does not help. As a first step
towards improving the situation, this change introduces separate README
files for the two crates. We keep the "landing page" README, but
basically just make it point to the individual crates to aid in
discoverability.

Signed-off-by: Daniel Müller <[email protected]>

Author: d-e-s-o

README.md

@@ -1,42 +1,7 @@
-![CI](https://github.com/libbpf/libbpf-rs/workflows/Rust/badge.svg?branch=master)
-[![rustc](https://img.shields.io/badge/rustc-1.63+-blue.svg)](https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html)
+## [libbpf-rs](libbpf-rs)
 
-WARNING: The API is not stable and is subject to breakage. Any breakage will
-include a minor version bump pre-1.0 and a major version bump post-1.0.
-[Semantic versioning](https://semver.org/) will be followed post-1.0 release.
+Idiomatic Rust wrapper around [libbpf](https://github.com/libbpf/libbpf).
 
-# libbpf-rs
+## [libbpf-cargo](libbpf-cargo)
 
-[![crates.io badge](https://img.shields.io/crates/v/libbpf-rs.svg)](https://crates.io/crates/libbpf-rs)
-
-Idiomatic rust wrapper around
-[libbpf](https://github.com/libbpf/libbpf)
-
-To use in your project, add into your `Cargo.toml`:
-
-```toml
-[dependencies]
-libbpf-rs = "0.20"
-```
-
-See [full documentation here](https://docs.rs/libbpf-rs).
-
-# libbpf-cargo
-
-[![crates.io badge](https://img.shields.io/crates/v/libbpf-cargo.svg)](https://crates.io/crates/libbpf-cargo)
-
-Helps you build and develop eBPF programs with standard rust tooling
-
-To use in your project, add into your `Cargo.toml`:
-
-```toml
-[build-dependencies]
-libbpf-cargo = "0.20"
-```
-
-See [full documentation here](https://docs.rs/libbpf-cargo).
-
-## Contributing
-
-We welcome all contributions! Please see the [contributor's
-guide](CONTRIBUTING.md) for more information.
+Helps you build and develop BPF programs with standard Rust tooling.

libbpf-cargo/Cargo.toml

@@ -4,7 +4,7 @@ description = "Cargo plugin to build bpf programs"
 repository = "https://github.com/libbpf/libbpf-rs"
 homepage = "https://github.com/libbpf/libbpf-rs"
 documentation = "https://docs.rs/crate/libbpf-cargo"
-readme = "../README.md"
+readme = "README.md"
 version = "0.20.0"
 authors = ["Daniel Xu <[email protected]>", "Daniel Müller <[email protected]>"]
 edition = "2021"

libbpf-cargo/README.md

@@ -0,0 +1,27 @@
+![CI](https://github.com/libbpf/libbpf-rs/workflows/Rust/badge.svg?branch=master)
+[![rustc](https://img.shields.io/badge/rustc-1.63+-blue.svg)](https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html)
+
+WARNING: The API is not stable and is subject to breakage. Any breakage will
+include a minor version bump pre-1.0 and a major version bump post-1.0.
+[Semantic versioning](https://semver.org/) will be followed post-1.0 release.
+
+# libbpf-cargo
+
+[![crates.io badge](https://img.shields.io/crates/v/libbpf-cargo.svg)](https://crates.io/crates/libbpf-cargo)
+
+Helps you build and develop BPF programs with standard Rust tooling.
+
+- [Changelog](CHANGELOG.md)
+
+To use in your project, add into your `Cargo.toml`:
+```toml
+[build-dependencies]
+libbpf-cargo = "0.20"
+```
+
+See [full documentation here](https://docs.rs/libbpf-cargo).
+
+## Contributing
+
+We welcome all contributions! Please see the [contributor's
+guide](../CONTRIBUTING.md) for more information.

libbpf-cargo/README.md

@@ -3,7 +3,7 @@ name = "libbpf-rs"
 description = "libbpf-rs is a safe, idiomatic, and opinionated wrapper around libbpf-sys"
 repository = "https://github.com/libbpf/libbpf-rs"
 homepage = "https://github.com/libbpf/libbpf-rs"
-readme = "../README.md"
+readme = "README.md"
 version = "0.20.0"
 authors = ["Daniel Xu <[email protected]>", "Daniel Müller <[email protected]>"]
 edition = "2021"

libbpf-rs/Cargo.toml

@@ -0,0 +1,27 @@
+![CI](https://github.com/libbpf/libbpf-rs/workflows/Rust/badge.svg?branch=master)
+[![rustc](https://img.shields.io/badge/rustc-1.63+-blue.svg)](https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html)
+
+WARNING: The API is not stable and is subject to breakage. Any breakage will
+include a minor version bump pre-1.0 and a major version bump post-1.0.
+[Semantic versioning](https://semver.org/) will be followed post-1.0 release.
+
+# libbpf-rs
+
+[![crates.io badge](https://img.shields.io/crates/v/libbpf-rs.svg)](https://crates.io/crates/libbpf-rs)
+
+Idiomatic Rust wrapper around [libbpf](https://github.com/libbpf/libbpf).
+
+- [Changelog](CHANGELOG.md)
+
+To use in your project, add into your `Cargo.toml`:
+```toml
+[dependencies]
+libbpf-rs = "0.20"
+```
+
+See [full documentation here](https://docs.rs/libbpf-rs).
+
+## Contributing
+
+We welcome all contributions! Please see the [contributor's
+guide](../CONTRIBUTING.md) for more information.