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

Commit

Permalink
Update Kamanda Documentations in the Read Me
Browse files Browse the repository at this point in the history
  • Loading branch information
mainawycliffe committed Apr 13, 2020
1 parent 913fd41 commit 5b44f50
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,20 @@ Firestore Data.

> This is not meant to replace Firebase CLI but to compliment it.
## Why?

Kamanda is meant to make you work as developer easier by providing with easier
and well built tools to make changes to your Firebase project quickly.

For instance you want to create a new admin user for your Firebase App, you can
use Kamanda to quickly add the user and attach the necessary custom claims. You
can also attach or remove a users custom claims, view list of users among other
functionality currently available for Firebase Auth.

In future as Kamanda gains support for Firestore, it will give you can easy way
to explore, export, import and manipulate your Firestore documents, right from
the cloud without writing extra code.

## Installation

> This is still an early version, feedback on improvements is much needed.
Expand All @@ -20,9 +34,49 @@ 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).
You can find the latest binaries for your operating system in the
[releases](https://github.com/mainawycliffe/kamanda/releases).

## Usage

There are a few things to keep in minds, Kamanda works inside a Firebase Project
and not outside and is meant to provide extra functionality and not replace
Firebase CLI.

First you will need to login just like Firebase CLI, this provides Kamanda with
the credentials it requires in order to perform most of the tasks.

You can login by running the following command:

```sh
kamanda login
```

> Kamanda mimics Firebase in this regard, so all authentication commands work
similar to Firebase CLI Authentication commands.

Login to your Google Account and Give Kamanda the permission it requires. As of
now, you might get a warning from Google, I am working to have the app verified
as soon as possible.

![Unsafe App Screen](docs/images/unsafe_app.png)

> Kamanda is a fully open source project, no information is corrected at any time.
## Features

Expand Down
Binary file added docs/images/unsafe_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b44f50

Please sign in to comment.