Skip to content

Commit

Permalink
refactor readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nitintf committed Mar 24, 2024
1 parent ede6f72 commit f7efd16
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@

## Usage

Before using Navi, you need to set your Gemini API key as an environment variable in your shell:

```shell
export GEMINI_API_KEY="..."
```

```shell
Navi - Your AI-powered Shell Guide

Expand Down Expand Up @@ -57,6 +51,19 @@ $ Explanation >>
the command explanation
```
## Installation
You can install Navi using the `go get` command:
```shell
go install github.com/nitintf/navi
```
After installation, don't forget to export your Gemini API key:
```shell
export GEMINI_API_KEY="..."
```
## Caution
While Navi uses AI to generate shell commands, it's important to understand that AI isn't perfect. Always review the generated commands before executing them, especially if you're working in a production environment or dealing with sensitive data. Navi is a tool designed to assist you, but it doesn't replace good judgment and understanding of shell commands.
Expand Down

0 comments on commit f7efd16

Please sign in to comment.