Skip to content

Commit

Permalink
docs(readme): update for the new major release
Browse files Browse the repository at this point in the history
  • Loading branch information
sharpvik committed Jan 27, 2023
1 parent 37afdea commit 52e6836
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,6 @@ derive their format from [Angular's commit rules][angular].
The `sema` command will help you follow these guidelines with no effort on your
part to memorise labels or double-check things.

## 🚨 Major Version Bump Notice

### Breaking Changes for `v2.0.0`

1. Commit hooks are no longer supported due to cross-platform support issues.

### Install with Homebrew

From now on, you can install `sema` using Homebrew. Follow through to the
[Installation](#install) section to learn more!

## 🌎 Contents

1. [Format](#format)
Expand All @@ -47,6 +36,7 @@ in a concise way, and `TYPE` is a short label from the following:
- `test`: adding missing tests, refactoring tests
- `perf`: performance improvements
- `chore`: updating grunt tasks
- `infra`: infrastructural changes

## <a name="install"></a> 🚀 Installation

Expand All @@ -65,7 +55,7 @@ yay -S sema
### Using the `go` tool

```bash
go install github.com/sharpvik/sema
go install github.com/sharpvik/sema@latest
```

> Both `yay` and `go` put `sema` binary into your `$GOPATH/bin` during
Expand All @@ -76,17 +66,25 @@ go install github.com/sharpvik/sema
### Overview

```bash
Usage: sema [flags]

-a, --add Begin by running `git add`
-f, --force Force push changes with `git push -f`
-l, --long Open editor to elaborate commit message
-b, --breaking Mark commit as introducing breaking changes
-p, --push Run `git push` on successful commit

-c, --contribute Open sema GitHub repository in browser
-h, --help Display help message
-v, --version Display current version of sema
NAME:
sema - Semantic commits made simple

USAGE:
sema [global options] command [command options] [arguments...]

COMMANDS:
github Open sema GitHub repository in browser
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--add, -a begin by running 'git add' (default: false)
--push, -p run 'git push' on successful commit (default: false)
--force, -f force push changes with 'git push -f' (default: false)
--long, -l open editor to elaborate commit message (default: false)
--breaking, -b mark commit as introducing breaking changes (default: false)
--tags, -t push tags along with commits (default: false)
--help, -h show help
--version, -v print the version
```

### Flag Combos
Expand Down

0 comments on commit 52e6836

Please sign in to comment.