Skip to content

Commit b31efbd

Browse files
committed
update readme with badges
1 parent e3fc7bf commit b31efbd

1 file changed

Lines changed: 29 additions & 7 deletions

File tree

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
1111
[![codebeat badge](https://codebeat.co/badges/4e12cb98-713b-4835-a118-338f1615ccab)](https://codebeat.co/projects/github-com-prabhuignoto-react-visual-grid-main)
1212
[![CodeFactor](https://www.codefactor.io/repository/github/prabhuignoto/react-visual-grid/badge)](https://www.codefactor.io/repository/github/prabhuignoto/react-visual-grid)
13+
![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-visual-grid)
1314

1415
</div>
1516

@@ -34,15 +35,18 @@
3435
- [Theme](#theme)
3536
- [⛏️ Built Using ](#️-built-using-)
3637
- [✍️ Authors ](#️-authors-)
38+
- [🤝Contributing](#contributing)
39+
- [Meta](#meta)
3740

3841
## ⚡ Features <a name = "about"></a>
3942

40-
- 🪟 Generate image grids quickly and easily.
43+
- 🪟 Generate grids easily.
44+
- ➡️ Render images horizontally or vertically in a grid.
4145
- ⚡ Built-in virtualization for improved performance.
4246
- 🖼️ Load thousands of images without worrying about performance.
4347
- 🎛️ UI controls for adjusting image sizes.
44-
- ➡️ Render images horizontally or vertically in a grid.
4548
- 💡 Resizable Grid
49+
- 📦 Lightweight (7kb gzipped)
4650
- 💪 Built with typescript.
4751
- 💡 Easy-to-understand API and a completely configurable React component.
4852

@@ -52,11 +56,11 @@
5256

5357
## 💭 How it works <a name = "working"></a>
5458

55-
`react-visual-grid` works with the absolute minimum of properties to determine the optimal method to render images. All that is required is to specify the picture sizes desired, and the component will automatically determine the optimum approach to render the images.
59+
`react-visual-grid` works with the absolute minimum of properties to determine the optimal method to render images. Specify the desired picture sizes and the layout, the component will automatically determine the optimum approach to rendering the images.
5660

57-
Because virtualization is built in, you won't have to worry about performance.
61+
Comes with two different layouts (horizontal and vertical) for rendering images. The in-built virtualization ensures that the component renders only the images that are visible on the screen. This ensures that the component is able to render thousands of images without any performance issues.
5862

59-
The component handles loading 5k+ photos with ease in the example. Both horizontal and vertical virtualization are supported.
63+
Resize the grid or go full screen, and the component will automatically adjust the image sizes to fit the new grid size.
6064

6165
## ⚙️ Installation <a name = "installation"></a>
6266

@@ -66,6 +70,8 @@ You can install `react-visual-grid` using npm or yarn.
6670
npm install react-visual-grid
6771
```
6872

73+
or
74+
6975
```bash
7076
yarn add react-visual-grid
7177
```
@@ -144,9 +150,9 @@ const App = () => {
144150

145151
## ImageSizes
146152

147-
`react-visual-grid` currently supports 3 zoom levels for the images. The default zoom level is 2x. The zoom levels can be configured using the `imageSizes` prop.
153+
`react-visual-grid` currently supports 3 zoom levels and the default level is 2x. The zoom levels can be configured using the `imageSizes` prop.
148154

149-
The component comes with a default configuration for the image sizes. The default configuration is as follows:
155+
The component comes with a default configuration for the image sizes.
150156

151157
```js
152158
export const defaultImageSizes = {
@@ -175,6 +181,7 @@ Here is the list of all the colors that can be customized:
175181

176182
| Name | Description | Type | Default |
177183
| :-------------------- | :------------------------------------ | :----- | :------------------ |
184+
| primaryColor | Primary color of the gallery | string | #007fff |
178185
| backgroundColor | Background color of the gallery | string | #000 |
179186
| controlBgColor | Background color of the control strip | string | #303030 |
180187
| controlBtnColor | Button color of the controls | string | #595959 |
@@ -206,3 +213,18 @@ Here is the list of all the colors that can be customized:
206213
## ✍️ Authors <a name = "authors"></a>
207214

208215
- [@prabhuignoto](https://github.com/prabhuignoto) - Idea & Initial work
216+
217+
## 🤝Contributing
218+
219+
1. [Fork it](https://github.com/prabhuignoto/react-chrono/fork)
220+
2. Create your feature branch (`git checkout -b new-feature`)
221+
3. Commit your changes (`git commit -am 'Add feature'`)
222+
4. Push to the branch (`git push origin new-feature`)
223+
5. Create a new Pull Request
224+
225+
## Meta
226+
227+
Distributed under the MIT license. See `LICENSE` for more information.
228+
229+
Prabhu Murthy – [@prabhumurthy2](https://twitter.com/prabhumurthy2)prabhu.m.murthy@gmail.com
230+
[https://github.com/prabhuignoto](https://github.com/prabhuignoto)

0 commit comments

Comments
 (0)