Skip to content

Commit f28d504

Browse files
Merge pull request #448 from silevis/readme
Update README
2 parents f04922a + e43e4c6 commit f28d504

2 files changed

Lines changed: 19 additions & 29 deletions

File tree

README.md

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
# ReactGrid - Spreadsheet experience for your React app
1+
<img alt="Sample app" src="public/rg-banner.png"/>
22

33
<div align="center">
44

55
ReactGrid is an open-source React component for displaying and editing data in a spreadsheet-like way. 🚀
66

77
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/silevis/reactgrid/blob/develop/LICENSE)
8-
[![Build Status](https://dev.azure.com/Silevis/ReactGrid/_apis/build/status/GitHub-MIT/Upgrade%20version%20and%20publish?branchName=master)](https://dev.azure.com/Silevis/ReactGrid/_build/latest?definitionId=17&branchName=master)
98
[![reactgrid](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/hwrqiy&style=flat&logo=cypress)](https://dashboard.cypress.io/projects/hwrqiy/runs)
10-
[![npm version](https://badge.fury.io/js/%40silevis%2Freactgrid.svg)](https://badge.fury.io/js/%40silevis%2Freactgrid)
119

1210
<img alt="Sample app" src="https://reactgrid.com/sample.gif"/>
1311

@@ -17,39 +15,31 @@ If you like our work, please give this project a star ⭐
1715
</div>
1816
&nbsp;
1917

20-
Prerequisites:
18+
# Check out the new v5-alpha version
2119

22-
- react: `16.13.1` || `17.0.0` `18.2.0`
23-
- react-dom: `16.13.1` || `17.0.0` || `18.2.0`
20+
🌐 [Visit our Homepage](https://silevis.github.io/reactgrid/)
2421

22+
📚 [Dive into the Documentation](https://silevis.github.io/reactgrid/docs/5.0/1-getting-started) to get started quickly and easily.
2523

24+
# Features
2625

27-
28-
29-
# Docs
30-
31-
- [Demo](https://reactgrid.com/examples/?utm_source=github&utm_medium=readme)
32-
- [Get started](https://reactgrid.com/docs/4.0/1-getting-started/?utm_source=github&utm_medium=readme)
33-
- [Documentation](https://reactgrid.com/docs/4.0/0-introduction/?utm_source=github&utm_medium=readme)
34-
- [API Reference](https://reactgrid.com/docs/4.0/7-api/?utm_source=github&utm_medium=readme)
35-
36-
# Browser support
37-
38-
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" />](http://godban.github.io/browsers-support-badges/)<br> Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" />](http://godban.github.io/browsers-support-badges/)<br> Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" />](http://godban.github.io/browsers-support-badges/)<br> Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" />](http://godban.github.io/browsers-support-badges/)<br> Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png" alt="iOS Safari" />](http://godban.github.io/browsers-support-badges/) <br>iOS/iPadOs Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png" alt="Samsung"/>](http://godban.github.io/browsers-support-badges/)<br> Samsung internet | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" />](http://godban.github.io/browsers-support-badges/)<br> Opera |
39-
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
40-
| 80+ | 61+ | 57+ | 13.1+ | 13+ | 9+ | 45+ |
26+
- Handling data changes
27+
- Column resizing
28+
- Column and row reordering
29+
- Sticky rows and columns
30+
- Keyboard shortcuts
31+
- Spanned cells
32+
- Range selection
33+
- Fill handle
34+
- Styled ranges
35+
- Custom styling
36+
- Custom cell types
37+
- Customizable behaviors
38+
- API hook that allows you to interact with a ReactGrid
4139

4240
# Licensing
4341

44-
ReactGrid is published under the MIT License (MIT).
45-
46-
(c) 2024 Silevis Software Sp. z o.o.
47-
48-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
49-
50-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
51-
52-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42+
ReactGrid is published under the [MIT License](./LICENSE).
5343

5444
# Authors
5545

public/rg-banner.png

19.9 KB
Loading

0 commit comments

Comments
 (0)