-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add missing crate READMEs and other cleanup (#458)
* Adds READMEs for the `libcnb-data` and `libcnb-proc-macros` crates, since previously they were bundling the repo root README, which was confusing when looking at their crates.io listing (#274). * Corrects the MSRV listed in the READMEs so it matches that defined in each crate's `Cargo.toml` after #445. * Adds badges to READMEs that didn't have them, to improve discoverability of the docs (eg towards #402) and awareness of latest version of each crate. Note: `libcnb-cargo` does not have a docs link since it's a binary not a library. * Syncs the `libcnb-cargo` usage example output with the latest output used in the repo root README. * Switches the docs.rs URLs style from `/*/` to `/latest/` since the former resolves to an exact version, which if bookmarked (or search engine indexed) will get out of date. * Various other small tweaks. Fixes #274. Addresses part of #402.
- Loading branch information
Showing
8 changed files
with
71 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# libcnb-data   [![Docs]][docs.rs] [![Latest Version]][crates.io] [![MSRV]][install-rust] | ||
|
||
Provides types for data formats specified in the Cloud Native Buildpack specification. | ||
|
||
If you wish to create buildpacks using the [libcnb.rs](https://github.com/heroku/libcnb.rs) | ||
framework, use the [libcnb](https://crates.io/crates/libcnb) crate rather than depending | ||
on this crate directly. | ||
|
||
[Docs]: https://img.shields.io/docsrs/libcnb-data | ||
[docs.rs]: https://docs.rs/libcnb-data/latest/libcnb_data/ | ||
[Latest Version]: https://img.shields.io/crates/v/libcnb-data.svg | ||
[crates.io]: https://crates.io/crates/libcnb-data | ||
[MSRV]: https://img.shields.io/badge/MSRV-rustc_1.59+-lightgray.svg | ||
[install-rust]: https://www.rust-lang.org/tools/install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# libcnb-proc-macros   [![Docs]][docs.rs] [![Latest Version]][crates.io] [![MSRV]][install-rust] | ||
|
||
Procedural macros used within the [libcnb.rs](https://github.com/heroku/libcnb.rs) framework. | ||
|
||
In most cases you should use the [libcnb](https://crates.io/crates/libcnb) crate rather than | ||
depending on this crate directly. | ||
|
||
[Docs]: https://img.shields.io/docsrs/libcnb-proc-macros | ||
[docs.rs]: https://docs.rs/libcnb-proc-macros/latest/libcnb_proc_macros/ | ||
[Latest Version]: https://img.shields.io/crates/v/libcnb-proc-macros.svg | ||
[crates.io]: https://crates.io/crates/libcnb-proc-macros | ||
[MSRV]: https://img.shields.io/badge/MSRV-rustc_1.59+-lightgray.svg | ||
[install-rust]: https://www.rust-lang.org/tools/install |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters