docs: update readme with install instructions (#108)

Author: ravisuhag

.github/workflows/release.yaml

@@ -1,9 +1,9 @@
-name: release
+name: Release
 
 on:
   push:
     tags:
-      - "v*.*.*"
+      - "v*"
 
 jobs:
   release:

.github/workflows/test.yaml

@@ -1,5 +1,7 @@
-on: [push, pull_request]
 name: Test
+
+on: [push, pull_request]
+
 jobs:
   golangci:
     name: lint

README.md

@@ -1,10 +1,11 @@
 # Guardian
 
 ![test workflow](https://github.com/odpf/guardian/actions/workflows/test.yaml/badge.svg)
+![release workflow](https://github.com/odpf/guardian/actions/workflows/release.yaml/badge.svg)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE)
 [![Version](https://img.shields.io/github/v/release/odpf/guardian?logo=semantic-release)](Version)
 
-Guardian is a data access management tool. It manages resources from various data providers along with the users’ access. Users required to raise an appeal in order to gain access to a particular resource. The appeal will go through several approvals before it is getting approved and granted the access to the user.
+Guardian is a on-demand access management tool. It manages resources from various data providers along with the users’ access. Users required to raise an appeal in order to gain access to a particular resource. The appeal will go through several approvals before it is getting approved and granted the access to the user.
 
 <p align="center"><img src="./docs/static/assets/overview.svg" /></p>
 
@@ -16,7 +17,7 @@ Guardian is a data access management tool. It manages resources from various dat
 - **Configurable approval flow**: Approval flow configures what are needed for an appeal to get approved and who are eligible to approve/reject. It can be configured and linked to a provider so that every appeal created to their resources will follow the procedure in order to get approved.
 - **External Identity Manager**: This gives the flexibility to use any third-party identity manager. User properties.
 
-## Usage
+## Documentation
 
 Explore the following resoruces to get started with Guardian:
 
@@ -25,25 +26,120 @@ Explore the following resoruces to get started with Guardian:
 - [Reference](https://odpf.github.io/guardian/docs/reference/glossary) contains details about configurations and other aspects of Guardian.
 - [Contribute](https://odpf.github.io/guardian/docs/contribute/contribution) contains resources for anyone who wants to contribute to Guardian.
 
+## Installation
+
+Install Guardian on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine.
+
+#### Binary (Cross-platform)
+
+Download the appropriate version for your platform from [releases](https://github.com/odpf/guardian/releases) page. Once downloaded, the binary can be run from anywhere.
+You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.
+Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
+
+#### Homebrew
+
+```sh
+# Install guardian (requires homebrew installed)
+$ brew install odpf/taps/guardian
+
+# Upgrade guardian (requires homebrew installed)
+$ brew upgrade guardian
+
+# Check for installed guardian version
+$ guardian version
+```
+
+## Usage
+
+Guardian CLI is fully featured but simple to use, even for those who have very limited experience working from the command line. Run `guardian --help` to see list of all available commands and instructions to use.
+
+```
+$ guardian --help
+Universal access control to cloud apps and infrastructure.
+
+USAGE
+  guardian <command> <subcommand> [flags]
+
+CORE COMMANDS
+  appeal      Manage appeals
+  policy      Manage policies
+  provider    Manage providers
+  resource    Manage resources
+
+DEV COMMANDS
+  migrate     Run database migrations
+  serve       Run guardian server
+
+ADDITIONAL COMMANDS
+  completion  generate the autocompletion script for the specified shell
+  config      Manage client configuration settings
+  help        Help about any command
+  version     Print version information
+
+FLAGS
+  --help   Show help for command
+
+EXAMPLES
+  $ guardian appeal create
+  $ guardian policy list
+  $ guardian provider list
+  $ guardian resource list
+  $ guardian policy create --file policy.yaml
+
+ENVIRONMENT VARIABLES
+  See 'guardian help environment' for the list of supported environment variables.
+
+LEARN MORE
+  Use 'guardian <command> <subcommand> --help' for more information about a command.
+  Read the manual at https://odpf.github.io/guardian/
+
+FEEDBACK
+  Open an issue here https://github.com/odpf/guardian/issues
+```
+
 ## Running locally
 
-Dependencies:
+<details>
+  <summary>Dependencies:</summary>
+
+    - Git
+    - Go 1.17 or above
+    - PostgreSQL 13.2 or above
 
-- Git
-- Go 1.15 or above
-- PostgreSQL 13.2 or above
+</details>
 
 ```sh
+# Clone the repo
 $ git clone [email protected]:odpf/guardian.git
-$ cd guardian
-$ go run main.go migrate
-$ go run main.go serve
+
+# Install all the golang dependencies
+$ make install
+
+# Check all build comamnds available
+$ make help
+
+# Build meteor binary file
+$ make build
+
+# Init config
+$ cp app/config.yaml config.yaml
+$ ./guardian config init
+
+# Run database migrations
+$ ./guardian migrate
+
+# Start guardian server
+$ ./guardian serve
 ```
 
 ## Running tests
 
 ```sh
+# Running all unit tests
 $ make test
+
+# Print code coverage
+$ make coverage
 ```
 
 ## Contribute

cmd/root.go

@@ -13,11 +13,7 @@ func New(cliConfig *app.CLIConfig) *cobra.Command {
 		Use:   "guardian <command> <subcommand> [flags]",
 		Short: "Universal data access control",
 		Long: heredoc.Doc(`
-			Universal data access control.
-
-			Guardian is a tool for extensible and universal data access with 
-			automated access workflows and security controls across data stores, 
-			analytical systems, and cloud products.`),
+			Universal access control to cloud apps and infrastructure.`),
 		SilenceUsage:  true,
 		SilenceErrors: true,
 		Example: heredoc.Doc(`