Skip to content

Commit

Permalink
Add relevant badges and logos (#372)
Browse files Browse the repository at this point in the history
Brush up and tack some badges onto the Rust package. They will be
visible in many places, like on crates.io, on docs.rs, on GitHub, and
so on. First impression is important. We can add more of these things
later, but they tend to slow down page loads so don't overdo it.

Also, move the rust-themis logo here (it's used by API docs).
Don't link to it via my personal domain, that's a bad practice.
  • Loading branch information
ilammy committed Feb 11, 2019
1 parent a2a8ba5 commit a3f9659
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 2 deletions.
4 changes: 4 additions & 0 deletions Cargo.toml
Expand Up @@ -17,6 +17,10 @@ include = [
"tests/rust/**/*",
]

[badges]
circle-ci = { repository = "cossacklabs/themis", branch = "master" }
maintenance = { status = "actively-developed" }

[workspace]

[lib]
Expand Down
10 changes: 10 additions & 0 deletions src/wrappers/themis/rust/README.md
@@ -1,8 +1,18 @@
# rust-themis

[![crates.io][crates-io-badge]][crates-io]
[![CircleCI][circle-ci-badge]][circle-ci]
[![License][license-badge]][license]

Rust binding for [Themis] crypto library.

[Themis]: https://github.com/cossacklabs/themis
[crates-io]: https://crates.io/crates/themis
[crates-io-badge]: https://img.shields.io/crates/v/themis.svg
[circle-ci]: https://circleci.com/gh/cossacklabs/themis/tree/master
[circle-ci-badge]: https://circleci.com/gh/cossacklabs/themis/tree/master.svg?style=shield
[license]: LICENSE
[license-badge]: https://img.shields.io/crates/l/themis.svg

## Usage

Expand Down
Binary file added src/wrappers/themis/rust/images/favicon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/wrappers/themis/rust/images/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions src/wrappers/themis/rust/libthemis-src/Cargo.toml
Expand Up @@ -11,6 +11,10 @@ keywords = ["crypto", "Themis"]
categories = ["development-tools::build-utils"]
license = "Apache-2.0"

[badges]
circle-ci = { repository = "cossacklabs/themis", branch = "master" }
maintenance = { status = "actively-developed" }

[dependencies]
make-cmd = "0.1.0"

Expand Down
4 changes: 4 additions & 0 deletions src/wrappers/themis/rust/libthemis-sys/Cargo.toml
Expand Up @@ -12,6 +12,10 @@ categories = ["cryptography", "external-ffi-bindings"]
license = "Apache-2.0"
links = "themis"

[badges]
circle-ci = { repository = "cossacklabs/themis", branch = "master" }
maintenance = { status = "actively-developed" }

[features]
vendored = ["libthemis-src"]

Expand Down
8 changes: 6 additions & 2 deletions src/wrappers/themis/rust/src/lib.rs
Expand Up @@ -43,8 +43,12 @@

#![warn(missing_docs)]
#![doc(html_no_source)]
#![doc(html_logo_url = "https://rust-themis.ilammy.net/images/logo.png")]
#![doc(html_favicon_url = "https://rust-themis.ilammy.net/images/favicon.png")]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/cossacklabs/themis/master/src/wrappers/themis/rust/images/logo.png"
)]
#![doc(
html_favicon_url = "https://raw.githubusercontent.com/cossacklabs/themis/master/src/wrappers/themis/rust/images/favicon.png"
)]

pub mod keygen;
pub mod keys;
Expand Down

0 comments on commit a3f9659

Please sign in to comment.