chore: update READMEs and licensing info

joshka · Jul 25, 2024 · 2fd4811 · 2fd4811
1 parent a354a94
commit 2fd4811
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 21 deletions.
diff --git a/LICENSE-MIT b/LICENSE-MIT
@@ -1,6 +1,6 @@
-MIT License
+# MIT License
 
-Copyright (c) 2023 Josh McKinney
+Copyright (c) Josh McKinney
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -17,3 +17,25 @@ Includes the following widgets, which are also available as standalone crates:
 - [tui-scrollview](https://crates.io/crates/tui-scrollview)
 
 <!-- cargo-rdme end -->
+
+## License
+
+Copyright (c) Josh McKinney
+
+This project is licensed under either of:
+
+- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)
+
+at your option.
+
+[LICENSE-APACHE]: /LICENSE-APACHE
+[LICENSE-MIT]: /LICENSE-MIT
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md).
diff --git a/tui-big-text/README.md b/tui-big-text/README.md
@@ -31,8 +31,7 @@ render be rendered. The builder allows you to customize the [`Style`] of the wid
 ## Examples
 
 ```rust
-use anyhow::Result;
-use ratatui::prelude::*;
+use ratatui::prelude::{Frame, Style, Stylize};
 use tui_big_text::{BigText, PixelSize};
 
 fn render(frame: &mut Frame) {
@@ -110,21 +109,22 @@ BigText::builder().alignment(Alignment::Center);
 
 ## License
 
-Copyright (c) 2023 Josh McKinney
+Copyright (c) Josh McKinney
 
-This project is licensed under either of
+This project is licensed under either of:
 
-- Apache License, Version 2.0
-   ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT license
-   ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)
 
 at your option.
 
+[LICENSE-APACHE]: /LICENSE-APACHE
+[LICENSE-MIT]: /LICENSE-MIT
+
 ## Contribution
 
-Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
-dual licensed as above, without any additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See [CONTRIBUTING.md](/CONTRIBUTING.md).
diff --git a/tui-popup/README.md b/tui-popup/README.md
@@ -110,6 +110,28 @@ frame.render_widget_ref(popup, area);
 - [ ] add nicer styling of header etc.
 - [ ] configure text wrapping in body to conform to a specific size
 
+## License
+
+Copyright (c) Josh McKinney
+
+This project is licensed under either of:
+
+- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)
+
+at your option.
+
+[LICENSE-APACHE]: /LICENSE-APACHE
+[LICENSE-MIT]: /LICENSE-MIT
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md).
+
 [Crates.io badge]: https://img.shields.io/crates/v/tui-popup?logo=rust&style=for-the-badge
 [tui-popup crate]: https://crates.io/crates/tui-popup
 [License badge]: https://img.shields.io/crates/l/tui-popup?style=for-the-badge

diff --git a/tui-prompts/README.md b/tui-prompts/README.md
@@ -1,4 +1,7 @@
-<h1><img src="https://user-images.githubusercontent.com/381361/252977280-49b9ff66-f78d-4e16-b5ed-29d771bfcab2.png"></h1>
+<h1>
+<img src="https://user-images.githubusercontent.com/381361/252977280-49b9ff66-f78d-4e16-b5ed-29d771bfcab2.png"
+    alt="logo">
+</h1>
 
 # tui-prompts
 
@@ -116,4 +119,22 @@ Or add the following to your `Cargo.toml` file:
 
 ## License
 
-Dual-licensed under [Apache 2.0](./LICENSE-APACHE) or [MIT](./LICENSE-MIT).
+Copyright (c) Josh McKinney
+
+This project is licensed under either of:
+
+- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)
+
+at your option.
+
+[LICENSE-APACHE]: /LICENSE-APACHE
+[LICENSE-MIT]: /LICENSE-MIT
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md).
diff --git a/tui-scrollview/README.md b/tui-scrollview/README.md
@@ -87,20 +87,22 @@ combination with any other widget.
 
 ## License
 
-Copyright (c) 2024 Josh McKinney
+Copyright (c) Josh McKinney
 
 This project is licensed under either of:
 
-- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
-  <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+- Apache License, Version 2.0 ([LICENSE-APACHE] or <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT license ([LICENSE-MIT] or <http://opensource.org/licenses/MIT>)
 
 at your option.
 
+[LICENSE-APACHE]: /LICENSE-APACHE
+[LICENSE-MIT]: /LICENSE-MIT
+
 ## Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
 work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
 additional terms or conditions.
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See [CONTRIBUTING.md](/CONTRIBUTING.md).