diff --git a/README.md b/README.md index 00e482f..e2c7de0 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,19 @@

Firereact is hooks, component and utilities library for Firebase and React.

+## Installation + +You can install the package via NPM: + +```bash +npm i firereact +``` + ## Features - Very lightweight, ![unpacked size](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2Ffirereact%2Flatest&query=%24.dist.unpackedSize&suffix=%20bytes&style=flat-square&label=%20) when unpacked, ![npm min bundle size](https://img.shields.io/bundlephobia/min/firereact?style=flat-square&label=%20) when minified, ![npm minzip bundle size](https://img.shields.io/bundlephobia/minzip/firereact?style=flat-square&label=%20) when minified+gzipped + - Supports ![Javascript](https://img.shields.io/badge/__-javascript-f7df1e?style=flat-square&logo=javascript&logoColor=white) and ![Typescript](https://img.shields.io/badge/__-typescript-3178c6?style=flat-square&logo=javascript&logoColor=white) - Supports Auth, Firestore, Functions, Providers and Storage. - Provides hooks such as `useUser` for Auth or `useDocument` for Firestore, which can listen to realtime changes as well - Provides custom components such as `` or `` to keep the logic simple and/or avoid unnecessary rerendering diff --git a/docs/index.md b/docs/index.md index 2091435..0a179e1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -49,6 +49,7 @@ ## Features - Very lightweight, ![unpacked size](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2Ffirereact%2Flatest&query=%24.dist.unpackedSize&suffix=%20bytes&style=flat-square&label=%20) + - Supports ![Javascript](https://img.shields.io/badge/__-javascript-f7df1e?style=flat-square&logo=javascript&logoColor=white) and ![Typescript](https://img.shields.io/badge/__-typescript-3178c6?style=flat-square&logo=javascript&logoColor=white) when unpacked, ![npm min bundle size](https://img.shields.io/bundlephobia/min/firereact?style=flat-square&label=%20) when minified, ![npm minzip bundle size](https://img.shields.io/bundlephobia/minzip/firereact?style=flat-square&label=%20) when minified+gzipped - Supports Auth, Firestore, Functions, Providers and Storage. - Provides hooks such as `useUser` for Auth or `useDocument` for Firestore, which can listen to realtime changes as well