From 3bfb278f81a9c550ee37a88c0cb0377331802542 Mon Sep 17 00:00:00 2001 From: Sai Kumar Peddireddy <35918740+sai-kumar-peddireddy@users.noreply.github.com> Date: Tue, 28 Mar 2023 19:15:48 +0530 Subject: [PATCH] docs: added Windows and Linux instalation steps in README (#116) --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed977b7472..9311fca9e6 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,24 @@ It has SRE experience codified into it's analyzers and helps to pull out the most relevent information to enrich it with AI. -## Quick Start +## Installation + +##### Linux/Mac via brew ``` brew tap k8sgpt-ai/k8sgpt brew install k8sgpt ``` +##### Windows + +* Download the latest Windows binaries of **k8sgpt** from the [Release](https://github.com/k8sgpt-ai/k8sgpt/releases) tab based on your system architecture. +* Extract the downloaded package to your desired location. Configure the system *path* variable with the binary location + +##### Verify installation + +* Run `k8sgpt version` + +## Quick Start * Currently the default AI provider is OpenAI, you will need to generate an API key from [OpenAI](https://openai.com) * You can do this by running `k8sgpt generate` to open a browser link to generate it