Skip to content

Commit

Permalink
Add more descriptions (#75)
Browse files Browse the repository at this point in the history
* add installation section

* add info for js and ts in features section
  • Loading branch information
erayerdin authored Feb 10, 2024
1 parent d29b486 commit 7844f36
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,19 @@

<p align="center">Firereact is hooks, component and utilities library for Firebase and React.</p>

## 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 `<FirestoreDocument />` or `<StorageDownloadLink />` to keep the logic simple and/or avoid unnecessary rerendering
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7844f36

Please sign in to comment.