Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missing crate READMEs and other cleanup #458

Merged
merged 2 commits into from
Jul 7, 2022
Merged

Add missing crate READMEs and other cleanup #458

merged 2 commits into from
Jul 7, 2022

Commits on Jul 7, 2022

  1. Add missing crate READMEs and other cleanup 

    * 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.
    @edmorley
    edmorley committed Jul 7, 2022
    Configuration menu
    Copy the full SHA
    55282f8 View commit details
    Browse the repository at this point in the history

  2. Couple more tweaks

    @edmorley
    edmorley committed Jul 7, 2022
    Configuration menu
    Copy the full SHA
    a18b507 View commit details
    Browse the repository at this point in the history