Skip to content

Commit

Permalink
Tweak READMEs (#229)
Browse files Browse the repository at this point in the history
  • Loading branch information
newpavlov authored Feb 24, 2025
1 parent 141cad9 commit 448baca
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 12 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# RustCrypto: Universal Hash Functions

![Rust Version][rustc-image]
[![Project Chat][chat-image]][chat-link]
[![dependency status][deps-image]][deps-link]
![Apache2/MIT licensed][license-image]
[![HAZMAT][hazmat-image]][hazmat-link]

Collection of [Universal Hash Functions][1] written in pure Rust.
Collection of [Universal Hash Functions] written in pure Rust.

## Crates

Expand All @@ -23,7 +24,7 @@ USE AT YOUR OWN RISK!

## Usage

Crates functionality is expressed in terms of traits defined in the [`universal-hash`][2] crate.
Crates functionality is expressed in terms of traits defined in the [`universal-hash`] crate.

## License

Expand All @@ -42,9 +43,11 @@ dual licensed as above, without any additional terms or conditions.

[//]: # (badges)

[rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/channel/260051-universal-hashes
[deps-image]: https://deps.rs/repo/github/RustCrypto/universal-hashes/status.svg
[deps-link]: https://deps.rs/repo/github/RustCrypto/universal-hashes
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md

Expand All @@ -58,5 +61,5 @@ dual licensed as above, without any additional terms or conditions.

[//]: # (footnotes)

[1]: https://en.wikipedia.org/wiki/Universal_hashing
[2]: https://docs.rs/universal-hash
[Universal Hash Functions]: https://en.wikipedia.org/wiki/Universal_hashing
[`universal-hash`]: https://docs.rs/universal-hash
7 changes: 5 additions & 2 deletions ghash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Project Chat][chat-image]][chat-link]
![Apache2/MIT licensed][license-image]
![Rust Version][rustc-image]
[![Build Status][build-image]][build-link]
Expand Down Expand Up @@ -56,10 +57,12 @@ dual licensed as above, without any additional terms or conditions.
[crate-link]: https://crates.io/crates/ghash
[docs-image]: https://docs.rs/ghash/badge.svg
[docs-link]: https://docs.rs/ghash/
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/channel/260051-universal-hashes
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
[build-image]: https://github.com/RustCrypto/universal-hashes/workflows/ghash/badge.svg?branch=master&event=push
[build-link]: https://github.com/RustCrypto/universal-hashes/actions?query=workflow%3Aghash
[build-image]: https://github.com/RustCrypto/universal-hashes/actions/workflows/ghash.yml/badge.svg?branch=master
[build-link]: https://github.com/RustCrypto/universal-hashes/actions/workflows/ghash.yml?query=branch:master
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md

Expand Down
7 changes: 5 additions & 2 deletions poly1305/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Project Chat][chat-image]][chat-link]
![Apache2/MIT licensed][license-image]
![Rust Version][rustc-image]
[![Build Status][build-image]][build-link]
Expand Down Expand Up @@ -60,10 +61,12 @@ dual licensed as above, without any additional terms or conditions.
[crate-link]: https://crates.io/crates/poly1305
[docs-image]: https://docs.rs/poly1305/badge.svg
[docs-link]: https://docs.rs/poly1305/
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/channel/260051-universal-hashes
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
[build-image]: https://github.com/RustCrypto/universal-hashes/workflows/poly1305/badge.svg?branch=master&event=push
[build-link]: https://github.com/RustCrypto/universal-hashes/actions?query=workflow%3Apoly1305
[build-image]: https://github.com/RustCrypto/universal-hashes/actions/workflows/poly1305.yml/badge.svg?branch=master
[build-link]: https://github.com/RustCrypto/universal-hashes/actions/workflows/poly1305.yml?query=branch:master
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
[hazmat-link]: https://github.com/RustCrypto/meta/blob/master/HAZMAT.md

Expand Down
7 changes: 5 additions & 2 deletions polyval/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
[![Project Chat][chat-image]][chat-link]
[![Build Status][build-image]][build-link]
![Apache2/MIT licensed][license-image]
![Rust Version][rustc-image]
Expand Down Expand Up @@ -59,8 +60,10 @@ dual licensed as above, without any additional terms or conditions.
[crate-link]: https://crates.io/crates/polyval
[docs-image]: https://docs.rs/polyval/badge.svg
[docs-link]: https://docs.rs/polyval/
[build-image]: https://github.com/RustCrypto/universal-hashes/workflows/polyval/badge.svg?branch=master&event=push
[build-link]: https://github.com/RustCrypto/universal-hashes/actions?query=workflow%3Apolyval
[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
[chat-link]: https://rustcrypto.zulipchat.com/#narrow/channel/260051-universal-hashes
[build-image]: https://github.com/RustCrypto/universal-hashes/actions/workflows/polyval.yml/badge.svg?branch=master
[build-link]: https://github.com/RustCrypto/universal-hashes/actions/workflows/polyval.yml?query=branch:master
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.85+-blue.svg
[hazmat-image]: https://img.shields.io/badge/crypto-hazmat%E2%9A%A0-red.svg
Expand Down

0 comments on commit 448baca

Please sign in to comment.