Skip to content

Commit

Permalink
📝 Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sjquant committed Sep 6, 2024
1 parent a330fb9 commit 5533c6b
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,15 @@ curl -fsSL https://raw.githubusercontent.com/sjquant/flopha/main/scripts/install
flopha next-version --pattern "release/{major}.{minor}.{patch}" --source branch --create
```

## CLI Options
## CLI Commands and Options

#### Options for NextVersion
### NextVersion

Calculates and displays the next version based on the current version in the repository.

#### Usage

#### Options

- `-i`, `--increment <INCREMENT>`: Specify the version part to increment. Options are:

Expand All @@ -86,7 +92,13 @@ curl -fsSL https://raw.githubusercontent.com/sjquant/flopha/main/scripts/install

- `-c`, `--create`: Creates a new tag or branch

#### Options for LastVersion
### LastVersion

Retrieves and displays the most recent version tag or branch in the repository that matches a specified pattern.

#### Usage

#### Options

- `-p`, `--pattern <PATTERN>`: Get the last version based on a given pattern (e.g., `v{major}.{minor}.{patch}`).

Expand All @@ -99,10 +111,6 @@ curl -fsSL https://raw.githubusercontent.com/sjquant/flopha/main/scripts/install

- `-c`, `--checkout`: Checks out the last version

### LastVersion

Finds the latest version tag or branch in the repository matching a given pattern.

## Why Choose flopha?

- **Simplify Semantic Versioning**: Automate version calculations based on your preferred patterns.
Expand Down

0 comments on commit 5533c6b

Please # to comment.