Skip to content

Commit 292ac72

Browse files
committed
docs: update README with badges and release strategy details
1 parent a238edb commit 292ac72

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
Material-UI themes for Squonk applications. Can be used independently with just Material-UI or with Emotion of Styled-Components.
1+
[![dependency - @squonk/mui-theme](https://img.shields.io/badge/%40squonk%2Fmui--theme-blue?logo=npm&logoColor=white)](https://www.npmjs.com/package/@squonk/mui-theme)
2+
[![GitHub tag](https://img.shields.io/github/tag/InformaticsMatters/squonk-react-mui-theme?include_prereleases=&sort=semver&color=blue)](https://github.com/InformaticsMatters/squonk-react-mui-theme/releases/)
3+
[![License](https://img.shields.io/badge/License-MIT-blue)](#license)
4+
5+
[![release](https://github.com/InformaticsMatters/squonk-react-mui-theme/actions/workflows/release.yaml/badge.svg?branch=dev&event=status)](https://github.com/InformaticsMatters/squonk-react-mui-theme/actions/workflows/release.yaml)
6+
[![release](https://github.com/InformaticsMatters/squonk-react-mui-theme/actions/workflows/release.yaml/badge.svg?branch=main&event=status)](https://github.com/InformaticsMatters/squonk-react-mui-theme/actions/workflows/release.yaml)
7+
8+
Material-UI theme for Squonk applications. Can be used independently with just Material-UI or with Emotion of Styled-Components.
29

310
## Examples
411

@@ -7,8 +14,6 @@ Material-UI themes for Squonk applications. Can be used independently with just
714
The colour scheme provides both a light and a dark theme. Mui v6 will automatically switch between schemes via media queries, taking into account the users system preference.
815

916
```tsx
10-
import React from 'react';
11-
1217
import { CssBaseline } from '@material-ui/core';
1318
import { StylesProvider, ThemeProvider as MuiThemeProvider } from '@material-ui/core/styles';
1419

@@ -44,8 +49,10 @@ import { ThemeProvider } from 'styled-components';
4449
<ThemeProvider theme={theme}>{...}</ThemeProvider>
4550
```
4651

47-
# Publishing a new Version
48-
49-
With made changes committed and pushed:
52+
# Release Strategy
5053

51-
1. Run `pnpm release`. This builds a `dist` with the `publishConfig` merged in.
54+
- Conventional commit messages are used to trigger new builds
55+
- Only `feat` and `fix` commit types will trigger a version bump
56+
- Commits pushed to the branch `dev` will trigger a tagged `dev` build. E.g. `5.0.1-dev.1`
57+
- Commits pushed to the default branch (`main`) will trigger a "official" tag. E.g. `5.0.1`
58+
- The package.json version, changelog will be updated and a the new version will be published to npm.

0 commit comments

Comments
 (0)