rust-template-example 0.1.5

An example showcasing the usage of https://github.com/PRO-2684/rust-template.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# rust-template-example

[![GitHub License](https://img.shields.io/github/license/PRO-2684/rust-template-example?logo=opensourceinitiative)](https://github.com/PRO-2684/rust-template-example/blob/main/LICENSE)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/PRO-2684/rust-template-example/release.yml?logo=githubactions)](https://github.com/PRO-2684/rust-template-example/blob/main/.github/workflows/release.yml)
[![GitHub Release](https://img.shields.io/github/v/release/PRO-2684/rust-template-example?logo=githubactions)](https://github.com/PRO-2684/rust-template-example/releases)
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/PRO-2684/rust-template-example/total?logo=github)](https://github.com/PRO-2684/rust-template-example/releases)
[![Crates.io Version](https://img.shields.io/crates/v/rust-template-example?logo=rust)](https://crates.io/crates/rust-template-example)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/rust-template-example?logo=rust)](https://crates.io/crates/rust-template-example)
[![docs.rs](https://img.shields.io/docsrs/rust-template-example?logo=rust)](https://docs.rs/rust-template-example)

An example showcasing the usage of https://github.com/PRO-2684/rust-template.

## ⚙️ Automatic Releases Setup

1. [Create a new GitHub repository](https://github.com/new) with the name `rust-template-example` and push this generated project to it.
2. Enable Actions for the repository, and grant "Read and write permissions" to the workflow [here](https://github.com/PRO-2684/rust-template-example/settings/actions).
3. [Generate an API token on crates.io](https://crates.io/settings/tokens/new), with the following setup:

    - `Name`: `rust-template-example`
    - `Expiration`: `No expiration`
    - `Scopes`: `publish-new`, `publish-update`
    - `Crates`: `rust-template-example`

4. [Add a repository secret](https://github.com/PRO-2684/rust-template-example/settings/secrets/actions/new) named `CARGO_TOKEN` with the generated token as its value.
5. Consider removing this section and updating this README with your own project information.

[Trusted Publishing](https://crates.io/docs/trusted-publishing) is a recent feature added to crates.io. To utilize it, first make sure you've already successfully published the crate to crates.io. Then, follow these steps:

1. [Add a new trusted publisher](https://crates.io/crates/rust-template-example/settings/new-trusted-publisher) to your crate.
    - Set "Workflow filename" to `release.yml`.
    - Keep other fields intact.
    - Click "Add".
2. Modify [`release.yml`](.github/workflows/release.yml).
    1. Comment out or remove the `publish-release` job.
    2. Un-comment the `trusted-publishing` job.
3. Remove the `CARGO_TOKEN` [repository secret](https://github.com/PRO-2684/rust-template-example/settings/secrets/actions).

## 📥 Installation

### Using [`binstall`](https://github.com/cargo-bins/cargo-binstall)

```shell
cargo binstall rust-template-example
```

### Downloading from Releases

Navigate to the [Releases page](https://github.com/PRO-2684/rust-template-example/releases) and download respective binary for your platform. Make sure to give it execute permissions.

### Compiling from Source

```shell
cargo install rust-template-example
```

## 💡 Examples

TODO

## 📖 Usage

TODO

## 🎉 Credits

TODO