@typesaurus/react/README.md

React Hooks for Typesaurus, type-safe Firestore ODM

🎉️ NEW: [Typesaurus X is out](https://blog.typesaurus.com/typesaurus-x-is-out/)!

# 🦕 Typesaurus React

React Hooks for [Typesaurus](https://github.com/kossnocorp/typesaurus), type-safe Firestore ODM.

→ [Read docs](https://typesaurus.com/integrations/react/)

## Installation

The library is available as an [npm package](https://www.npmjs.com/package/@typesaurus/react).
To install Typesaurus, run:

```sh
npm install --save @typesaurus/react typesaurus firebase firebase-admin
```

_Note that Typesaurus React has Typesaurus listed as a peer dependency, which also requires the `firebase` package to work in the web environment and `firebase-admin` to work in Node.js. These packages aren't listed as dependencies, so they won't install automatically with the Typesaurus package. Also, you'll need `react` installed._

## Changelog

See [the changelog](./CHANGELOG.md).

## License

[MIT © Sasha Koss](https://kossnocorp.mit-license.org/)