steemconnect-firebase-functions/docs/index.md

A TypeScript library that can help you build applications with SteemConnect and Firebase.

# **Welcome** to the documentation of...

**steemconnect-firebase-function** - a TypeScript library that can help you build applications with _SteemConnect_ and _Firebase_.

## What can you do with this tool?

* **implement** OAuth2 Authorization Code Grant
* **broadcast** operations to the Steem blockchain
* **check** OAuth2 error types
* **mint** Firebase Custom Tokens
* **create** Firebase Auth accounts for your users with additional data
* **store** tokens in the Firebase Cloud Firestore

## Quick start

To get started started, you simply have to install it via **NPM**:

```cmd
npm i steemconnect-firebase-functions
```