Skip to content
This repository has been archived by the owner on May 16, 2021. It is now read-only.

Commit

Permalink
Update Installation Instructions
Browse files Browse the repository at this point in the history
Update Installation Instructions

Update Docs

Update Docs Site

Uodate Docs Site

Update Docs
  • Loading branch information
mainawycliffe committed May 24, 2020
1 parent c753d0d commit b36fdac
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 31 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
[![](https://github.com/mainawycliffe/kamanda/workflows/Go%20Tests/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22Go+Tests%22)
[![](https://github.com/mainawycliffe/kamanda/workflows/Go%20Linting/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22Go+Linting%22)
[![](https://github.com/mainawycliffe/kamanda/workflows/Go%20Release/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22Go+Release%22)
[![](https://github.com/mainawycliffe/kamanda/workflows/npm%20publish/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22npm+publish%22)

Kamanda is an open source tool is meant to provide additional functionality not provided by Firebase
CLI such as Managing Users of your Projects, Exporting and Importing of Cloud
Expand Down Expand Up @@ -54,7 +53,11 @@ You can use npm to install Kamanda:
npm -g install kamanda
```

> NB: At the moment, it doesn't work with yarn, I am working on a solution for this.
You can also use yarn to install Kamanda:

```sh
yarn global add kamanda
```

To check if installation was completed successfully, run the following
command:
Expand Down
31 changes: 2 additions & 29 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Firestore Data."
[![](https://github.com/mainawycliffe/kamanda/workflows/Go%20Tests/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22Go+Tests%22)
[![](https://github.com/mainawycliffe/kamanda/workflows/Go%20Linting/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22Go+Linting%22)
[![](https://github.com/mainawycliffe/kamanda/workflows/Go%20Release/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22Go+Release%22)
[![](https://github.com/mainawycliffe/kamanda/workflows/npm%20publish/badge.svg)](https://github.com/mainawycliffe/kamanda/actions?query=workflow%3A%22npm+publish%22)

Kamanda is an open source tool tool is meant to provide additional functionality not provided by Firebase
CLI such as Managing Users of your Projects, Exporting and Importing of Cloud
Expand Down Expand Up @@ -63,35 +62,9 @@ users.

## Installation

> This is still an early version, feedback on improvements is much needed.
### Using npm (Node Package Manager)

You can use npm to install Kamanda:
Follow the installation instruction [here](/installation).

```sh
npm -g install kamanda
```

> NB: At the moment, it doesn't work with yarn, I am working on a solution for this.
To check if installation was completed successfully, run the following
command:

```sh
kamanda version
```

You can view all supported commands [here](./docs/kamanda.md) or by running `kamanda help`

```sh
kamanda help
```

### Executable Binaries

You can find the latest binaries for your operating system in the
[releases](https://github.com/mainawycliffe/kamanda/releases).
> This is still an early version, feedback on improvements is much needed.
## Usage

Expand Down
6 changes: 6 additions & 0 deletions docs/themes/kamanda/layouts/partials/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@
</span>
<strong>Installation</strong>
</a>
<a target="_blank" class="navbar-item" href="https://github.com/mainawycliffe/kamanda/releases">
<span class="icon is-medium">
<i class="fas fa-list"></i>
</span>
<strong>Releases</strong>
</a>
<a class="navbar-item" href="https://github.com/mainawycliffe/kamanda">
<span class="icon is-medium">
<i class="fab fa-github"></i>
Expand Down

0 comments on commit b36fdac

Please sign in to comment.