Skip to content

Commit

Permalink
📝 Improve documentation
Browse files Browse the repository at this point in the history
Improve documentation layout and update sections to provide more
accurate information.
  • Loading branch information
mikelorant committed Dec 25, 2022
1 parent 703e1e8 commit 64232cd
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,24 @@ commits by showing you the layout in the same format as `git log`.

## Features

- Built-in editor
- Emoji support
- Switch to a different author profile
- Does not take over the entire screen
- Built-in multiline editor
- Emoji selector
- Author profile switching
- Inline text interface
- Subject line counter
- Appends sign-off
- Formats body to a maximum of 72 characters
- Best practises recommendations
- Formats body width to 72 characters
- Best practise recommendations

## Interface
## Installation

Install Committed with Homebrew.

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

## Views

### Main

Expand Down Expand Up @@ -181,15 +189,6 @@ Date: Mon Jan 2 15:04:05 2006 -0700
3 files changed, 2 insertions(+), 1 deletions(-)
```

## Installation

Install Committed with Homebrew.

```bash
brew tap mikelorant/homebrew-custom
brew install committed
```

## Shortcuts

**Global**
Expand All @@ -210,7 +209,7 @@ Install Committed with Homebrew.
**Emoji**

| Command | Key |
| ------------- | --------- |
| :------------ | :-------- |
| Clear emoji | delete |
| Reset filter | escape |
| Next page | page down |
Expand Down

0 comments on commit 64232cd

Please sign in to comment.