@gmencz/faunadb/README.md

TypeScript-first FaunaDB client with static type inference

<p align="center">
  <a aria-label="CI workflow status" href="https://github.com/gmencz/faunadb/actions/workflows/main.yml">
    <img alt="" src="https://github.com/gmencz/faunadb/actions/workflows/main.yml/badge.svg">
  </a>
  
  <a aria-label="Semantic release" href="https://github.com/semantic-release/semantic-release">
    <img alt="" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
  </a>

  <a aria-label="NPM version" href="https://www.npmjs.com/package/@gmencz/faunadb">
    <img alt="" src="https://badgen.net/npm/v/@gmencz/faunadb">
  </a>

  <a aria-label="Package size" href="https://bundlephobia.com/result?p=@gmencz/faunadb">
    <img alt="" src="https://badgen.net/bundlephobia/minzip/@gmencz/faunadb">
  </a>

  <a aria-label="License" href="https://github.com/gmencz/faunadb/blob/main/LICENSE">
    <img alt="" src="https://badgen.net/npm/license/@gmencz/faunadb">
  </a>
</p>

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [Issues](#issues)
  - [🐛 Bugs](#-bugs)
  - [💡 Feature Requests](#-feature-requests)
- [LICENSE](#license)

## Introduction

TypeScript-first FaunaDB client with static type inference. You declare what your FaunaDB schema looks like and the client will ensure your queries are written correctly.

One of the main focuses of the library is to keep the bundle size as small as possible due to FaunaDB being used the most in serverless environments where script size is limited.

## Installation

```
npm install @gmencz/faunadb
```

## Usage

## Issues

### 🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

[**See Bugs**](https://github.com/gmencz/faunadb/issues?utf8=%e2%9c%93&q=is%3aissue+is%3aopen+sort%3acreated-desc+label%3abug)

### 💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.

[**See Feature Requests**](https://github.com/gmencz/faunadb/issues?utf8=%e2%9c%93&q=is%3aissue+is%3aopen+sort%3areactions-%2b1-desc+label%3aenhancement)

## LICENSE

MIT