Skip to content

Commit

Permalink
docs: fix
Browse files Browse the repository at this point in the history
  • Loading branch information
henomis committed Apr 7, 2023
1 parent 2fe1e03 commit 408bf54
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# ai-shell-go

[![Build Status](https://github.com/henomis/ai-shell-go/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/henomis/ai-shell-go/actions/workflows/test.yml?query=branch%3Amain) [![GoDoc](https://godoc.org/github.com/henomis/ai-shell-go?status.svg)](https://godoc.org/github.com/henomis/ai-shell-go) [![Go Report Card](https://goreportcard.com/badge/github.com/henomis/ai-shell-go)](https://goreportcard.com/report/github.com/henomis/ai-shell-go) [![GitHub release](https://img.shields.io/github/release/henomis/ai-shell-go.svg)](https://github.com/henomis/ai-shell-go/releases)

This is a simple AI shell helper written in GO. It use OpenAI API to generate a plausible command from a given prompt.
As soon as the command is generated, the user can choose to execute it or revise it adding more context.

## Installation
Be sure to have a working Go environment, then clone the repository and run the following command:

```
$ make
$ go get -u github.com/henomis/ai-shell-go
```

## Usage
Expand Down

0 comments on commit 408bf54

Please sign in to comment.