Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Commit 44e73f8

Browse files
committed
updated README
1 parent 58bb2b9 commit 44e73f8

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ The dimensions auto adjust based on the window size (view port) or the screen si
88

99
Support for responsive dimension hooks to help auto-adjust dimensions for devices whose display or screen sizes may change such as foldable phones or browser windows! 😎
1010

11-
<!-- [![Build Status][build-badge]][build]
11+
[![Build Status][build-badge]][build]
1212
[![Maintainability][maintainability-badge]][maintainability-url]
13-
[![Test Coverage][coverage-badge]][coverage-url] -->
13+
[![Test Coverage][coverage-badge]][coverage-url]
1414

1515
[![Version][version-badge]][package]
1616
[![Downloads][downloads-badge]][npmtrends]
@@ -161,11 +161,25 @@ const App = () => {
161161
- [Using Responsive Height & Width (snack)][responsive-example]
162162
- [Using the Responsive Hooks (react-native-web)][responsive-hooks-example]
163163

164+
## Why Responsive Dimensions
165+
166+
I built responsive dimensions as a personal tool to tackle some of my problems I face during my everyday app development. You might want to use it if your usecase comes under one of the following scenarios.
167+
168+
- While working with React Native UI (especially animations) there are lots of scenarios that require calculating a certain percentage of the display area.
169+
170+
- If your app supports tablets then you might want to scale some of your fonts & UI Components based on the display size.
171+
172+
- If you are using react-native-web or targetting foldable devices your UI needs to react to the changes in the window dimensions.
173+
174+
## TODO
175+
176+
- [ ] Fix Github Actions pipleline
177+
164178
[build]: https://github.com/DaniAkash/react-native-responsive-dimensions/actions
165179
[build-badge]: https://github.com/daniakash/react-native-responsive-dimensions/workflows/build/badge.svg
166-
[coverage-badge]: https://api.codeclimate.com/v1/badges/f7954c1e1686cabeeb97/test_coverage
180+
[coverage-badge]: https://api.codeclimate.com/v1/badges/0cf535fb8d3da2aa4a91/test_coverage
167181
[coverage-url]: https://codeclimate.com/github/DaniAkash/react-native-responsive-dimensions/test_coverage
168-
[maintainability-badge]: https://api.codeclimate.com/v1/badges/f7954c1e1686cabeeb97/maintainability
182+
[maintainability-badge]: https://api.codeclimate.com/v1/badges/0cf535fb8d3da2aa4a91/maintainability
169183
[maintainability-url]: https://codeclimate.com/github/DaniAkash/react-native-responsive-dimensions/maintainability
170184
[bundle-phobia-badge]: https://badgen.net/bundlephobia/minzip/react-native-responsive-dimensions
171185
[bundle-phobia]: https://bundlephobia.com/result?p=react-native-responsive-dimensions

0 commit comments

Comments
 (0)