From 39971fa5defc4e600656c2e229410c793ce8d103 Mon Sep 17 00:00:00 2001 From: jakepage91 Date: Wed, 1 Mar 2023 16:17:54 +0000 Subject: [PATCH] added an updated readme file --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f2e7e38..3f78a76 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,47 @@ -## Usage +# Komiser Homebrew +

Amp Logo

+ + +## Description +Komiser is an open-source cloud-agnostic resource manager. It integrates with multiple cloud providers (including AWS, Azure, OCI, DigitalOcean, Kubernetes and CIVO, Linode, Tencent and Scaleway), builds a cloud asset inventory, and helps you break down your cost at the resource level 💰 + +Cloud version is available in private beta, sign in for free at https://cloud.tailwarden.com + +## Installation +### To install Komiser using Homebrew, follow these steps: + +If you haven't already, install `Homebrew` by running the following command in your terminal: +``` +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +``` +Once Homebrew is installed, run the following command to tap into the `Komiser` formula: ``` brew tap tailwarden/komiser brew install komiser ``` +## Updating Komiser +Every week we ship a minor upgrade to Komiser, whenver you want to update the the latest version, simply run: +``` +brew update +brew reinstall komiser +``` + +## Learn more + +- Need and [installation guide](https://docs.komiser.io/docs/introduction/getting-started?utm_source=github&utm_medium=refferal&utm_campaign=content)? We got you covered! +- Want to contribute to the repo? Check out [this article](https://www.tailwarden.com/blog/how-to-contribute-to-komiser?utm_source=github&utm_medium=refferal&utm_campaign=content), which will give you all of the information you will need. +- Not sure which is the latest version of Komiser? Check the [changelog](https://www.tailwarden.com/changelog?utm_source=github&utm_medium=refferal&utm_campaign=content) + +## Bug reporting + + +Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/tailwarden/homebrew-komiser/issues). + +## Reach out to us directly +Apart from opening GitHub issues one of the easiest way to communicate directly with the team is by joinging the [discord server](https://discord.tailwarden.com) where you can head on over to the `#help-komiser` channel and get all of your questions answered. + + + + +For more information on how to use Komiser and its various features, please refer to the [official documentation](https://docs.komiser.io?utm_source=github&utm_medium=refferal&utm_campaign=content). \ No newline at end of file