Skip to content

Commit 728581b

Browse files
committed
docs(README.md): semantic release
1 parent c33a3f2 commit 728581b

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

.storybook/stories/Introduction/installation.story.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { Meta } from '@storybook/addon-docs/blocks';
77
[![Version][version-badge]][package]
88
[![Size][size-badge]][size]
99
[![Types][type-badge]][package]
10+
[![Semantic Release][semantic-release-badge]][semantic-release]
1011
[![License][license-badge]][license]
1112
[![Code of Conduct][coc-badge]][coc]
1213
[![Changelog][changelog-badge]][changelog]
@@ -46,6 +47,8 @@ yarn add @table-library/react-table-library @emotion/react
4647

4748
## Usage
4849

50+
* **[Demo](https://react-tables.com/)**
51+
4952
```javascript
5053
import { CompactTable } from '@table-library/react-table-library/compact';
5154

@@ -103,7 +106,7 @@ In 2020, [Robin Wieruch](https://www.robinwieruch.de) created React Table Librar
103106

104107
There are two kinds of table libraries for React: heavyweight and lightweight.
105108

106-
On the one side of the spectrum, there are **heavyweight table libraries** which are often shipped by UI libraries such as Material UI. These tables have all batteries included, however, they often lack in modern concepts such as composition over configuration, customization, extensibility and first-class server-side operations. When you have to create one giant configuration object for one giant table component, you know that you are working with a heavyweight table library.
109+
On the one side of the spectrum, there are **heavyweight table libraries** which are often shipped by UI libraries such as MUI X. These tables have all batteries included, however, they often lack in modern concepts such as composition over configuration, customization, extensibility and first-class server-side operations. When you have to create one giant configuration object for one giant table component, you know that you are working with a heavyweight table library.
107110

108111
On the other side of the spectrum, there are **lightweight table libraries**. The most popular one is React Table which is a great library and at the time the status quo in the React community. I very much like this library and used it myself, however, when creating complex tables (read: server-side operations, customizations, feature compositions) from scratch, I always felt like re-inventing the wheel all the time, because I didn't receive enough handholding from the library.
109112

@@ -114,8 +117,10 @@ With **React Table Library** I wanted to have something in between heavyweight a
114117
[type-badge]: https://img.shields.io/npm/types/@table-library/react-table-library
115118
[license-badge]: https://img.shields.io/npm/l/@table-library/react-table-library.svg
116119
[license]: https://github.com/table-library/react-table-library/blob/master/LICENSE
120+
[semantic-release-badge]: https://img.shields.io/badge/%F0%9F%9A%80-semantic--release-blueviolet
121+
[semantic-release]: https://github.com/table-library/react-table-library/releases
117122
[github-star-badge]: https://img.shields.io/github/stars/table-library/react-table-library?style=social
118-
[github-star]: https://github.com/table-library/react-table-library/
123+
[github-star]: https://github.com/table-library/react-table-library/stargazers
119124
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg
120125
[coc]: https://github.com/table-library/react-table-library/blob/master/CODE_OF_CONDUCT.md
121126
[changelog-badge]: https://img.shields.io/badge/Change-Log-blue

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
[![Version][version-badge]][package]
66
[![Size][size-badge]][size]
7-
[![type-badge]][package]
7+
[![Types][type-badge]][package]
8+
[![Semantic Release][semantic-release-badge]][semantic-release]
89
[![License][license-badge]][license]
910
[![Code of Conduct][coc-badge]][coc]
1011
[![Changelog][changelog-badge]][changelog]
@@ -46,7 +47,8 @@ yarn add @table-library/react-table-library @emotion/react
4647

4748
## Usage
4849

49-
**[Documentation](https://react-table-library.com/)**
50+
* **[Documentation](https://react-table-library.com/)**
51+
* **[Demo](https://react-tables.com/)**
5052

5153
```javascript
5254
import { CompactTable } from '@table-library/react-table-library/compact';
@@ -106,8 +108,10 @@ In 2020, [Robin Wieruch](https://www.robinwieruch.de) created React Table Librar
106108
[type-badge]: https://img.shields.io/npm/types/@table-library/react-table-library
107109
[license-badge]: https://img.shields.io/npm/l/@table-library/react-table-library.svg
108110
[license]: https://github.com/table-library/react-table-library/blob/master/LICENSE
111+
[semantic-release-badge]: https://img.shields.io/badge/%F0%9F%9A%80-semantic--release-blueviolet
112+
[semantic-release]: https://github.com/table-library/react-table-library/releases
109113
[github-star-badge]: https://img.shields.io/github/stars/table-library/react-table-library?style=social
110-
[github-star]: https://github.com/table-library/react-table-library/
114+
[github-star]: https://github.com/table-library/react-table-library/stargazers
111115
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg
112116
[coc]: https://github.com/table-library/react-table-library/blob/master/CODE_OF_CONDUCT.md
113117
[changelog-badge]: https://img.shields.io/badge/Change-Log-blue

0 commit comments

Comments
 (0)