Skip to content

Commit

Permalink
add unpacked size badge
Browse files Browse the repository at this point in the history
  • Loading branch information
erayerdin committed Feb 19, 2024
1 parent 4c4bf78 commit da4a75e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ 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
- Provides `Provider`s such as `FirebaseSuiteProvider`, `FirebaseAuthProvider` or `FirestoreProvider` to access Firebase service instances anywhere in the component tree without relying on global variables or prop-drilling
- Comprehensive documentation
- Very lightweight, ![unpacked size](https://img.shields.io/npm/unpacked-size/firereact?label=%20&style=flat-square)
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
- Provides `Provider`s such as `FirebaseSuiteProvider`, `FirebaseAuthProvider` or `FirestoreProvider` to access Firebase service instances anywhere in the component tree without relying on global variables or prop-drilling
- Comprehensive documentation

## Documentation

Expand All @@ -58,9 +58,9 @@ To use this library, check out the documentation [here](https://firereact.erayer

You are welcome to contribute to the project. Before contributing:

- Always send pull requests to `dev` branch, which is the default branch of this repository. `main` branch is used for latest published version.
- You agree our [code of conduct](CODE_OF_CONDUCT.md).
- Always send pull requests to `dev` branch, which is the default branch of this repository. `main` branch is used for latest published version.
- You agree our [code of conduct](CODE_OF_CONDUCT.md).

## License

This library is licensed under [MIT License](https://www.tldrlegal.com/license/mit-license#w-tabs-0-data-w-pane-1).
This library is licensed under [MIT License](https://www.tldrlegal.com/license/mit-license#w-tabs-0-data-w-pane-1).
19 changes: 10 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,15 @@

## 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
- Provides custom components such as `<FirestoreDocument />` or `<StorageDownloadLink />` to keep the logic simple and/or avoid unnecessary rerendering
- Provides `Provider`s such as `FirebaseSuiteProvider`, `FirebaseAuthProvider` or `FirestoreProvider` to access Firebase service instances anywhere in the component tree without relying on global variables or prop-drilling
- Comprehensive documentation
- Very lightweight, ![unpacked size](https://img.shields.io/npm/unpacked-size/firereact?label=%20&style=flat-square)
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)
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
- Provides custom components such as `<FirestoreDocument />` or `<StorageDownloadLink />` to keep the logic simple and/or avoid unnecessary rerendering
- Provides `Provider`s such as `FirebaseSuiteProvider`, `FirebaseAuthProvider` or `FirestoreProvider` to access Firebase service instances anywhere in the component tree without relying on global variables or prop-drilling
- Comprehensive documentation

## Installation

Expand All @@ -72,4 +73,4 @@ Firereact is licensed under the terms of [MIT License](https://www.tldrlegal.com
[npm_link]: https://www.npmjs.com/package/firereact
[actions_link]: https://github.com/erayerdin/firereact/actions
[codecov_link]: https://app.codecov.io/gh/erayerdin/firereact
[docs_link]: http://firereact.erayerdin.com/
[docs_link]: http://firereact.erayerdin.com/

0 comments on commit da4a75e

Please sign in to comment.