Skip to content

Commit

Permalink
TEST-1234 ```
Browse files Browse the repository at this point in the history
Add Gemini API Key Requirement

Update documentation to include Gemini API Key requirement
```
  • Loading branch information
wesleyscholl committed Sep 23, 2024
1 parent 2931478 commit 82087d3
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,15 @@ Staging, committing, and pushing code is a repetative manual process. Writing de
| Git Push | Pushing local commits to remote branch with `git push`. |
| Git Push Retry (Pull & Push) | If a push fails, the script will `git pull` from the remote branch and push again. |

## Alias Command

| Name | Description |
| -------------- | -------------------------------------------------------- |
| Alias Command | The alias command to be used for the script: `cm`. |

## Requirements

| Name | Description | Link, Location, or Command |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| Terminal or Shell | A terminal or shell for configuring and running the script. | [Download Terminal](https://www.apple.com/macos/terminal/) |
| `Git Bash` **\*Required for Windows** | Git Bash provides a Unix command line emulator for windows which can be used to run Git, shell commands, and much more. | [Download Git Bash](https://gitforwindows.org/) |
| Google Gemini API Key | A Gemini API key is required to use Gemini AI to generate commit messages. | [Get Gemini API Key](https://www.getgemini.ai/) |
| Shell Alias Command | The alias command to be used for the script. | `cm` - set with `export` in bash profile or .zshrc file |


## Installation

Expand Down

0 comments on commit 82087d3

Please sign in to comment.