Skip to content

Commit 07feb10

Browse files
committed
Update README.md with links to published content
Update the README.md with links to the following published content: * A link to crate.io, that hosts the Tindercrypt crate. * A link to docs.rs, that hosts the Tindercrypt documentation. * A link to Github's releases page, that hosts the Tindercrypt binaries.
1 parent 86c7794 commit 07feb10

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and self-contained encryption metadata"
1010
"""
1111
homepage = "https://github.com/apyrgio/tindercrypt"
1212
repository = "https://github.com/apyrgio/tindercrypt"
13-
documentation = "https://github.com/apyrgio/tindercrypt"
13+
documentation = "https://docs.rs/tindercrypt"
1414
readme = "README.md"
1515
keywords = ["protocol-buffers", "cryptorgraphy", "encryption"]
1616
categories = ["command-line-utilities", "cryptography"]

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ passwords/passphrases. Uses [Protocol Buffers] for the serialization of the
55
encryption metadata (salts, nonces, etc.) and is based on the [ring] Rust crate
66
for the cryptographic primitives.
77

8+
[![Crates.io](https://img.shields.io/crates/v/tindercrypt.svg)](https://crates.io/crates/tindercrypt)
9+
[![Docs.rs](https://docs.rs/tindercrypt/badge.svg)](https://docs.rs/tindercrypt)
10+
811
## Overview
912

1013
Tindercrypt's main goal is to provide a safe and easy API for data
@@ -29,6 +32,8 @@ Features:
2932
* Offers a simple, multi-platform CLI tool that encrypts files with a
3033
passphrase.
3134

35+
For a design overview, see the docs section on [Tindercrypt metadata].
36+
3237
## Examples
3338

3439
You can encrypt (seal) a data buffer with a passphrase as follows:
@@ -45,6 +50,8 @@ let plaintext2 = cryptor.open(pass, &ciphertext)?;
4550
assert_eq!(plaintext2, plaintext);
4651
```
4752

53+
You can find more examples in the docs section on [Tindercrypt's `RingCryptor`].
54+
4855
The equivalent operation in the CLI tool is the following:
4956

5057
```
@@ -55,8 +62,15 @@ $ tindercrypt decrypt -i ciphertext
5562
The cake is a lie
5663
```
5764

65+
## Documentation
66+
67+
You can read the latest docs in https://docs.rs/tindercrypt.
68+
5869
## Installation
5970

71+
You can run Tindercrypt using one of the binaries in the [Releases page] of this
72+
repo. Alternatively, you can install it with one of the following methods:
73+
6074
* From cargo:
6175

6276
```
@@ -94,15 +108,17 @@ Finally, read the [`NOTICE.md`] file for the legal status of the project.
94108
Licensed under MPL-2.0. Please read the [`NOTICE.md`] and [`LICENSE`] files for
95109
the full copyright and license information. If you feel like putting your
96110
mental stability to a test, feel free to read the [`LEGAL.md`] file for a foray
97-
into the waters of copyright law, and a glimpse of how they can be boring and
98-
dangerous at the same time.
111+
into the waters of copyright law, and a glimpse of how they can be both boring
112+
and dangerous at the same time.
99113

100114
[ring]: https://github.com/briansmith/ring
101-
<!--[protobuf]: https://github.com/stepancheg/rust-protobuf-->
102115
[Protocol Buffers]: https://developers.google.com/protocol-buffers/
103116
[PBKDF2]: https://en.wikipedia.org/wiki/PBKDF2
104117
[AES256-GCM]: https://en.wikipedia.org/wiki/Galois/Counter_Mode
105118
[ChaCha20-Poly1305]: https://tools.ietf.org/html/rfc7539
119+
[Tindercrypt metadata]: https://docs.rs/tindercrypt/latest/tindercrypt/metadata/index.html
120+
[Tindercrypt's `RingCryptor`]: https://docs.rs/tindercrypt/latest/tindercrypt/cryptors/struct.RingCryptor.html
121+
[Releases page]: https://github.com/apyrgio/tindercrypt/releases
106122
[`prototool`]: https://github.com/uber/prototool
107123
[`NOTICE.md`]: /NOTICE.md
108124
[`LICENSE`]: /LICENSE

0 commit comments

Comments
 (0)