Skip to content

Commit

Permalink
📝 Update highlights in documentation
Browse files Browse the repository at this point in the history
Add and improve hightlight section. Bold text identifies the most
important features. Newer capabilities such as amend and themes were
added to the list.
  • Loading branch information
mikelorant committed Jan 28, 2023
1 parent 256890b commit ec174a7
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ commits by showing you the layout in the same format as `git log`.

## 💡 Highlights [](#committed)

- Built-in multiline editor
- Emoji selector
- Author profile switching
- Inline text interface
- Subject line counter
- Appends sign-off
- Formats body width to 72 characters
- Best practise recommendations
- Built-in **multiline editor** with rich capabilities.
- Custom **emoji selector** providing popular sets to choose from.
- **Switch author** before applying the commit.
- Inline **text interface** mimics the Git log output.
- Dynamic **subject line counter**.
- Toggle appending **sign-off** required by many open source projects.
- Automatically **hard wraps** body to 72 characters.
- Best practise **recommendations**.
- Import and **amend** previous commit.
- **Adaptive colours** with **light** and **dark** themes.

## 🐾 First Steps [](#committed)

Expand Down Expand Up @@ -84,8 +86,8 @@ update the list.

Install Committed with Homebrew.

```bash
brew install mikelorant/taps/committed
```shell
$ brew install mikelorant/taps/committed
```

## 🎛 Usage [](#committed)
Expand Down

0 comments on commit ec174a7

Please sign in to comment.