diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d4904d..1a1d07c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,6 @@ At the moment, these kind of contributions are more appreciated and should be pr - New file transfers: for further details see [Implementing File Transfer](#implementing-file-transfers) - Code optimizations: any optimization to the code is welcome - See also features described in [Upcoming features](./README.md##upcoming-features-). Open an issue first though. -- A **logo** for the project: I'd really love to have a logo for termscp 💛 For any other kind of contribution, especially for new features, please submit a new issue first. diff --git a/README.md b/README.md index 941baa1..8552176 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # TermSCP +

+ +

+ [![License: MIT](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/licenses/MIT) [![Stars](https://img.shields.io/github/stars/veeso/termscp.svg)](https://github.com/veeso/termscp) [![Downloads](https://img.shields.io/crates/d/termscp.svg)](https://crates.io/crates/termscp) [![Crates.io](https://img.shields.io/badge/crates.io-v0.5.0-orange.svg)](https://crates.io/crates/termscp) [![Docs](https://docs.rs/termscp/badge.svg)](https://docs.rs/termscp) [![Build](https://github.com/veeso/termscp/workflows/Linux/badge.svg)](https://github.com/veeso/termscp/actions) [![Build](https://github.com/veeso/termscp/workflows/MacOS/badge.svg)](https://github.com/veeso/termscp/actions) [![Build](https://github.com/veeso/termscp/workflows/Windows/badge.svg)](https://github.com/veeso/termscp/actions) diff --git a/assets/images/termscp-128.png b/assets/images/termscp-128.png new file mode 100644 index 0000000..182b420 Binary files /dev/null and b/assets/images/termscp-128.png differ diff --git a/assets/images/termscp-512.png b/assets/images/termscp-512.png new file mode 100644 index 0000000..d7a0314 Binary files /dev/null and b/assets/images/termscp-512.png differ diff --git a/assets/images/termscp-64.png b/assets/images/termscp-64.png new file mode 100644 index 0000000..1157bbd Binary files /dev/null and b/assets/images/termscp-64.png differ diff --git a/assets/images/termscp-96.png b/assets/images/termscp-96.png new file mode 100644 index 0000000..dd69b75 Binary files /dev/null and b/assets/images/termscp-96.png differ diff --git a/assets/images/termscp.svg b/assets/images/termscp.svg new file mode 100644 index 0000000..60d42a2 --- /dev/null +++ b/assets/images/termscp.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index 009b403..de77513 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,11 @@ +#![doc(html_playground_url = "https://play.rust-lang.org")] +#![doc( + html_favicon_url = "https://raw.githubusercontent.com/veeso/termscp/main/assets/images/termscp-128.png" +)] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/veeso/termscp/main/assets/images/termscp-512.png" +)] + /** * MIT License *