Skip to content

Commit

Permalink
docs: ✏️ new add and list commands
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiofcferreira committed Oct 27, 2024
1 parent b2014a5 commit b3f3e51
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ npm add --save-dev tripauthor
yarn add --dev tripauthor
```

## Usage
## Configuration

### Global configuration
### Global hooks

**By doing this, all repositories will use the global hooks even if they have git hooks configured.**
```bash
Expand All @@ -34,13 +34,26 @@ chmod a+x ~/githooks/*
### Husky
```bash
echo "yarn tripauthor -f $1" > .husky/commit-msg
echo "exec < /dev/tty && yarn tripauthor -f $1" > .husky/commit-msg
chmod a+x .husky/commit-msg
```
## Add more coauthors
## Usage
### Set up new co-author
```bash
npx tripauthor add <name> <email>
# alias
npx tripauthor a <name> <email>
```
### List configured co-authors
```bash
echo "name <email>" >> ~/.git_coauthors
npx tripauthor list
# alias
npx tripauthor l
```

0 comments on commit b3f3e51

Please sign in to comment.