Skip to content

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sjquant committed Jul 11, 2022
1 parent 4bd9f98 commit d34a279
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,41 @@ Shell (Mac, Linux):
```
curl -fsSL https://raw.githubusercontent.com/sjquant/flopha/main/scripts/install.sh | sh
```

## Getting Started

1. You can create feature branch with

```sh
flohpa start-feature -b <feature-name>
```

which creates branch with a given name and checkout to the branch.

2. You can finish feature branch with

```sh
flopha finish-feature
```

which pushes your branch to remote. You don't have to do things like `git push --set-upstream origin <feature-name>`.
3. You can start hotfix with
```sh
flohpa start-hotfix
```
which searches the latest tag on the remote, and checkout to the tag.
4. You can finish hotfix with
```sh
flopha finish-hotfix
```
which creates new tag with patch version up, and push it to the remote.
## Notes
I wanted to make my github workflow at my company easier, and start my project with `Rust`. It might not be fit to your needs. If you have any opinions to improve `flopha`, I'm very open to them.

0 comments on commit d34a279

Please sign in to comment.