chore: fix gitopia action and modify README (#81)

* chore: fix gitopia action and modify README

Signed-off-by: Siddhant N Trivedi <siddhant@deepsource.io>

* chore: add more info

Signed-off-by: Siddhant N Trivedi <siddhant@deepsource.io>

* chore: rephrase

Signed-off-by: Siddhant N Trivedi <siddhant@deepsource.io>

* fix: fix discord server statement

Signed-off-by: Siddhant N Trivedi <siddhant@deepsource.io>

* Update README.md

Co-authored-by: Sourya Vatsyayan <sourya@deepsource.io>

Author: siddhant-deepsource

.github/workflows/gitopia-mirror.yml

@@ -17,7 +17,7 @@ jobs:
           node-version: 12
           registry-url: https://registry.npmjs.org/
       - name: Gitopia Mirror Action
-        uses: gitopia/gitopia-mirror-action@v0.1.2
+        uses: gitopia/gitopia-mirror-action@v0.3.0
         with:
           gitopiaWallet: "${{ secrets.ARWEAVE_WALLET }}"
           branch: "master"

README.md

@@ -20,28 +20,67 @@
 
 Command line interface to DeepSource
 
-[![DeepSource](https://deepsource.io/gh/deepsourcelabs/cli.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/deepsourcelabs/cli/?ref=repository-badge)[![CircleCI](https://circleci.com/gh/deepsourcelabs/cli.svg?style=svg)](https://circleci.com/gh/deepsourcelabs/cli)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/deepsourcelabs/cli)
+[![DeepSource](https://deepsource.io/gh/deepsourcelabs/cli.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/deepsourcelabs/cli/?ref=repository-badge)
 [![Gitopia](https://img.shields.io/endpoint?style=&url=https://gitopia.org/mirror-badge.json)](https://gitopia.org/#/WU8MwK_wNu7had5xKwuD2dilKn9gzCFH6carv-QmIKs/deepsource-cli)
 
-### Usage
+## Installation
 
+### macOS
+
+DeepSource CLI is available on macOS via [Homebrew](https://brew.sh/):
+
+```sh
+brew install deepsourcelabs/cli/deepsource
+```
+### Binary Installation
+
+```sh
+curl https://deepsource.io/cli | sh
 ```
-DeepSource Command Line Interface v0.x.x
+This script will detect the operating system and architecture and puts deepsource binary in `./bin/deepsource`.
+
+## Configuring DSN
+
+In order to report test-coverage to DeepSource using the `report` command, an environment variable named as `DEEPSOURCE_DSN` has to
+be set. It's value will be available under 'Settings' tab of the repository page.
+
+## Usage
 
+The CLI provides access to a wide range of commands. Here is a list of the
+commands along with their brief description.
+
+```
 Usage:
     deepsource <command> [<arguments>]
 
 Available commands are:
-    report        Report an artifact to an analyzer
+    report      Report an artifact to an analyzer
+    config      Generate and Validate DeepSource config
+    help        Help about any command
+    issues      Show the list of issues in a file in a repository
+    repo        Operations related to the project repository
+    report      Report artifacts to DeepSource
+    version     Get the version of the DeepSource CLI
 
 Help:
-    Use 'deepsource <command> --help' for more information about the command.
+    Use 'deepsource <command> --help/-h' for more information about the command.
 ```
 
-### Documentation
+## Documentation
+
+For complete documentation, refer to the [CLI Documentation](https://deepsource.io/docs/cli/usage)
+
+## Feedback/Support
+
+Want to share any feedback or need any help regarding the CLI? Feel free to
+reach out to us at [support@deepsource.io](mailto:support@deepsource.io) or at
+our [Discord server](https://discord.gg/3aNjyD9k2q).
+
+## Community
 
-[https://deepsource.io/docs/config/cli](https://deepsource.io/docs/config/cli.html)
+Interested in DeepSource and want to chat with the community? Feel free to join our [Discord server](http://deepsource.io/discord).
 
-### Support
+## License
 
-[support@deepsource.io](mailto:support@deepsource.io)
+Licensed under the [BSD 2-Clause "Simplified" License](https://github.com/deepsourcelabs/cli/blob/master/LICENSE).