Skip to content

Commit 76e510c

Browse files
committed
feat: update docs
Signed-off-by: Matt Gleich <git@mattglei.ch>
1 parent e0a81d1 commit 76e510c

File tree

3 files changed

+10
-59
lines changed

3 files changed

+10
-59
lines changed

.github/workflows/contributors.yml

-17
This file was deleted.

.github/workflows/fsync.yml

-18
This file was deleted.

README.md

+10-24
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[![build](https://github.com/gleich/resin/actions/workflows/build.yml/badge.svg)](https://github.com/gleich/resin/actions/workflows/build.yml)
77
[![test](https://github.com/gleich/resin/actions/workflows/test.yml/badge.svg)](https://github.com/gleich/resin/actions/workflows/test.yml)
88

9-
⚗️ Superfast CLI for the conventional commits commit format
9+
Superfast CLI for the conventional commits commit format
1010

11-
## What is resin?
11+
## What is resin?
1212

1313
resin is a CLI (command-line interface) tool that makes it easy to create commit messages that follow the [conventional commit format](https://www.conventionalcommits.org/). Here is a little demo:
1414

@@ -17,12 +17,12 @@ resin is a CLI (command-line interface) tool that makes it easy to create commit
1717
This demo will create the following commit message:
1818

1919
```txt
20-
feat(config): add crates.io fields
20+
feat[config]: add crates.io fields
2121
```
2222

23-
## Features
23+
## Features
2424

25-
### 🚩 Flags
25+
### Flags
2626

2727
resin has three flags:
2828

@@ -32,17 +32,17 @@ resin has three flags:
3232

3333
Super simple and easy to use!
3434

35-
### ⚙️ Configuration
35+
### Configuration
3636

37-
#### 📖 Scopes
37+
#### Scopes
3838

3939
You can configure resin to have your custom scopes. Below is an example config:
4040

4141
```toml
4242
scopes = ['docker', 'github actions']
4343
```
4444

45-
#### ✍️ Sign-off message
45+
#### Sign-off message
4646

4747
You can also have a sign-off message that is based off the contents of your `~/.gitconfig` file:
4848

@@ -56,28 +56,14 @@ This will create a message that will automatically be added to the bottom of you
5656
Signed-off-by: Matt Gleich <git@mattglei.ch>
5757
```
5858

59-
#### 📁 Location
59+
#### Location
6060

6161
This file can be stored in `~/.config/resin/config.toml` or on a per-project basis by putting it at the root of the project with the same name. You can see a demo of this [for this project](resin.toml)
6262

63-
## 🚀 Install
63+
## Install
6464

6565
You can install resin using [cargo](https://doc.rust-lang.org/cargo/index.html):
6666

6767
```bash
6868
cargo install resin
6969
```
70-
71-
## 🙌 Contributing
72-
73-
We would love to have you contribute! Please read the [contributing guide](CONTRIBUTING.md) before submitting a pull request. Thank you in advance!
74-
75-
<!-- prettier-ignore-start -->
76-
<!-- DO NOT REMOVE - contributor_list:start -->
77-
## 👥 Contributors
78-
79-
80-
- **[@gleich](https://github.com/gleich)**
81-
82-
<!-- DO NOT REMOVE - contributor_list:end -->
83-
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)