docs: prepare instability-example for publish (#18)

- reword README
- set msrv to 1.64
- fix feature flags in example
- fix licenses (remove NOTICES, use The Ratatui Developers)
- remove CODEOWNERS file

Author: joshka

.github/workflows/check.yml

@@ -67,9 +67,9 @@ jobs:
           RUSTDOCFLAGS: --cfg docsrs
   msrv:
     # check that we can build using the minimal rust version that is specified by this crate
-    name: Check MSRV (1.63)
+    name: Check MSRV (1.64)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@1.63
+      - uses: dtolnay/rust-toolchain@1.64
       - run: cargo check

CODEOWNERS

@@ -1,25 +1,37 @@
+[workspace]
+resolver = "2"
+members = ["example"]
+
+[workspace.package]
+authors = ["Stephen M. Coakley <[email protected]>", "The Ratatui Developers"]
+license = "MIT"
+version = "0.3.4"
+edition = "2021"
+rust-version = "1.64"
+repository = "https://github.com/ratatui-org/instability"
+
+[workspace.dependencies]
+instability = { path = ".", version = "0.3.4" }
+
 [package]
 name = "instability"
-version = "0.3.4"
 description = "Rust API stability attributes for the rest of us. A fork of the `stability` crate."
-authors = ["Stephen M. Coakley <[email protected]>", "Joshka"]
-license = "MIT"
-repository = "https://github.com/ratatui-org/instability"
 documentation = "https://docs.rs/instability/"
+authors.workspace = true
+license.workspace = true
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+repository.workspace = true
 readme = "README.md"
-edition = "2021"
-rust-version = "1.63"
 
 [dependencies]
 darling = "0.20.10"
 indoc = "2.0.5"
 pretty_assertions = "1.4.1"
-proc-macro2 = "1.0.89"
-quote = "1.0.26"
-syn = { version = "2.0.15", features = ["derive", "full"] }
+proc-macro2 = "1.0.92"
+quote = "1.0.37"
+syn = { version = "2.0.90", features = ["derive", "full"] }
 
 [lib]
 proc-macro = true
-
-[workspace]
-members = ["example"]

Cargo.toml

@@ -1,6 +1,7 @@
 # MIT License
 
 Copyright (c) 2020 Stephen M. Coakley
+Copyright (c) The Ratatui Developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md

@@ -2,47 +2,64 @@
 
 Rust API stability attributes for the rest of us.
 
-[![Crates.io](https://img.shields.io/crates/v/instability.svg)](https://crates.io/crates/instability)
-[![Documentation](https://docs.rs/instability/badge.svg)][documentation]
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
-![Minimum supported Rust version](https://img.shields.io/badge/rustc-1.63+-yellow.svg)
-[![Build](https://github.com/ratatui-org/instability/workflows/Check/badge.svg)](https://github.com/ratatui-org/instability/actions)
-[![Build](https://github.com/ratatui-org/instability/workflows/Test/badge.svg)](https://github.com/ratatui-org/instability/actions)
+[![Crate Badge]][Crate] [![Build Badge]][Build] [![Docs Badge]][Docs] [![License Badge]][License]
+![MSRV Badge]
 
 ## Overview
 
-This is a fork of the [Stability](https://crates.io/crates/stability) crate with the
-[blessing](https://github.com/sagebind/stability/issues/12) of the original maintainer Stephen M.
-Coakley ([@sagebind](https://github.com/sagebind)). This crate provides attribute macros for
-specifying API stability of public API items of a crate. For a quick example:
+This crate provides attribute macros for specifying API stability of public API items of a crate. It
+is a [fork] of the [Stability] original created by Stephen M. Coakley ([@sagebind]).
+
+## Usage
+
+Add the `instability` crate to your `Cargo.toml` file:
+
+```shell
+cargo add instability
+```
+
+Then, use the `#[instability::stable]` and `#[instability::unstable]` attributes to specify the
+stability of your API items:
 
 ```rust
 /// This function does something really risky!
-///
-/// Don't use it yet!
 #[instability::unstable(feature = "risky-function")]
 pub fn risky_function() {
-    unimplemented!()
+    println!("This function is unstable!");
 }
-```
-
-Please check out the [documentation] for detailed usage.
 
-## Installation
+/// This function is safe to use!
+#[instability::stable(since = "1.0.0")]
+pub fn stable_function() {
+    println!("This function is stable!");
+}
+```
 
-Install via Cargo by adding to your `Cargo.toml` file:
+A feature flag prefixed with "unstable-" will be created that can be used to enable unstable items.
+The macro will append an extra documentation comment that describes the stability of the item. The
+visibility of the item will be changed to `pub(crate)` when the feature is not enabled (or when the
+attribute is on an impl block, the entire block will be removed).
 
-```toml
-[dependencies]
-instability = "0.3"
-```
+Check out the [Docs] for detailed usage. See [instability-example] for a complete example.
 
-### Supported Rust versions
+## MSRV
 
-The current release is only guaranteed to work with the latest stable Rust compiler.
+The minimum supported Rust version (MSRV) is 1.64.0.
 
 ## License
 
-This project's source code and documentation are licensed under the MIT license. See the [LICENSE](LICENSE.md) file for details.
+This project's source code and documentation are licensed under the MIT [License].
 
-[documentation]: https://docs.rs/instability
+[Crate Badge]: https://img.shields.io/crates/v/instability
+[Build Badge]: https://img.shields.io/github/actions/workflow/status/ratatui/instability/check.yml
+[Docs Badge]: https://img.shields.io/docsrs/instability
+[License Badge]: https://img.shields.io/crates/l/instability
+[MSRV Badge]: https://img.shields.io/crates/msrv/instability
+[Crate]: https://crates.io/crates/instability
+[Build]: https://github.com/ratatui/instability/actions/workflows/check.yml
+[Docs]: https://docs.rs/instability
+[License]: ./LICENSE.md
+[stability]: https://crates.io/crates/stability
+[@Sagebind]: https://github.com/sagebind
+[fork]: https://github.com/sagebind/stability/issues/12
+[instability-example]: https://crates.io/crates/instability-example

NOTICES.md

@@ -1,17 +1,31 @@
 [package]
 name = "instability-example"
-version = "0.0.0"
 description = "Example crate demonstrating instablity usage."
-authors = ["Stephen M. Coakley <[email protected]>", "Joshka"]
-edition = "2021"
-publish = false
+documentation = "https://docs.rs/instability-example/"
+authors.workspace = true
+license.workspace = true
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+repository.workspace = true
 
 [features]
-unstable-risky-function = []
-unstable-risky-struct = []
+default = []
+unstable-enum = []
+unstable-constant = []
+unstable-function = []
+unstable-method = []
+unstable-module = []
+unstable-private-function = []
+unstable-reexport = []
+unstable-static = []
+unstable-struct-with-issue = []
+unstable-struct = []
+unstable-trait = []
+unstable-type-alias = []
 
 [dependencies]
-instability = { path = "../" }
+instability.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true

README.md

@@ -0,0 +1,26 @@
+# Instability-example
+
+This crate is an example of using the stability attributes from the [instability crate].
+
+[![Crate Badge]][Crate] [![Build Badge]][Build] [![Docs Badge]][Docs] [![License Badge]][License]
+![MSRV Badge]
+
+## Overview
+
+- Example code: [lib.rs](./src/lib.rs).
+- Output: See the [Docs.rs][Docs] page for the output of the example code.
+
+## License
+
+This project's source code and documentation are licensed under the MIT [License].
+
+[instability crate]: https://crates.io/crates/instability
+[Crate Badge]: https://img.shields.io/crates/v/instability-example
+[Build Badge]: https://img.shields.io/github/actions/workflow/status/ratatui/instability/check.yml
+[Docs Badge]: https://img.shields.io/docsrs/instability-example
+[License Badge]: https://img.shields.io/crates/l/instability-example
+[MSRV Badge]: https://img.shields.io/crates/msrv/instability-example
+[Crate]: https://crates.io/crates/instability-example
+[Build]: https://github.com/ratatui/instability/actions/workflows/check.yml
+[Docs]: https://docs.rs/instability-example
+[License]: ../LICENSE.md

example/Cargo.toml

@@ -1,8 +1,7 @@
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![allow(dead_code)]
 
-//! This is an example library demonstrating various attributes from the
-//! stability crate.
+//! This is an example library demonstrating various attributes from the [`instability`] crate.
 
 /// A stable type alias
 ///