Shorten license section in the READMEs (#67)

* Update codec README.md * Update common README.md * Update macro README.md
JSorngard · Oct 24, 2024 · cdc7bd5 · cdc7bd5
1 parent e2c3682
commit cdc7bd5
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 25 deletions.
diff --git a/codec/README.md b/codec/README.md
@@ -130,19 +130,19 @@ The crate is based on the encoding and decoding functions
 by Scott Conner. They were first presented in [this post](https://www.reddit.com/r/ProgrammerHumor/comments/yqof9f/the_most_upvoted_comment_picks_the_next_line_of/ivrd9ur/?context=3)
 together with the above explanation.
 
-## License
-
-Licensed under either of
+<br>
 
-- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/JSorngard/zalgo_codec/blob/main/codec/LICENSE-APACHE)
- or <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT license ([LICENSE-MIT](https://github.com/JSorngard/zalgo_codec/blob/main/codec/LICENSE-MIT)
- or <http://opensource.org/licenses/MIT>)
+### License
 
-at your option.
+<sup>
+Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
+2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
+</sup>
 
-## Contribution
+<br>
 
+<sub>
 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.
+</sub>
diff --git a/common/README.md b/common/README.md
@@ -63,19 +63,19 @@ It can be installed with `cargo install zalgo-codec --features binary`.
 You can optionally enable the `gui` feature during installation to include a
 rudimentary GUI mode for the program.
 
-## License
+<br>
 
-Licensed under either of
+### License
 
-- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/JSorngard/zalgo_codec/blob/main/common/LICENSE-APACHE)
- or <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT license ([LICENSE-MIT](https://github.com/JSorngard/zalgo_codec/blob/main/common/LICENSE-MIT)
- or <http://opensource.org/licenses/MIT>)
+<sup>
+Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
+2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
+</sup>
 
-at your option.
-
-## Contribution
+<br>
 
+<sub>
 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.
+</sub>
diff --git a/macro/README.md b/macro/README.md
@@ -18,17 +18,19 @@ zalgo_embed!("E͎͓͕͉̞͉͆̀͑́͒̈̀̓̒̉̀̍̀̓̒̀͛̀̊̀͘̚͘͘͝ͅ"
 assert_eq!(square(10), 100);
 ```
 
-## License
+<br>
 
-Licensed under either of
+### License
 
-- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/JSorngard/zalgo_codec/blob/main/macro/LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
-- MIT license ([LICENSE-MIT](https://github.com/JSorngard/zalgo_codec/blob/main/macro/LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
+<sup>
+Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
+2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
+</sup>
 
-at your option.
-
-## Contribution
+<br>
 
+<sub>
 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.
+</sub>