From 408bf54de72c45e11b7ce5341ca98e4a5f446d4f Mon Sep 17 00:00:00 2001 From: Simone Vellei Date: Fri, 7 Apr 2023 12:00:33 +0200 Subject: [PATCH] docs: fix --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3373133..5e69a41 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # 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. @@ -6,7 +9,7 @@ As soon as the command is generated, the user can choose to execute it or revise 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