Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wojciechmarek committed Nov 3, 2023
1 parent 98a76c1 commit dcf58da
Show file tree
Hide file tree
Showing 3 changed files with 448 additions and 12 deletions.
14 changes: 14 additions & 0 deletions .versionrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"types": [
{ "type": "feat", "section": "Features" },
{ "type": "fix", "section": "Bug Fixes" },
{ "type": "chore", "hidden": true },
{ "type": "docs", "hidden": true },
{ "type": "style", "hidden": true },
{ "type": "refactor", "hidden": true },
{ "type": "perf", "hidden": true },
{ "type": "test", "hidden": true }
],
"commitUrlFormat": "https://github.com/wojciechmarek/todo-list/commits/{{hash}}",
"compareUrlFormat": "https://github.com/wojciechmarek/todo-list/compare/{{previousTag}}...{{currentTag}}"
}
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ All design styles are written from scratch. This application does not use any UI
- 🧪 **Testing:** jest, react-testing-library
- 💎 **Others:** desktop-first approach, atomic design, progressive web app, docker and dev container

## Versioning

This application uses conventional commits for generating changelog and versioning. The change log is available at [CHANGELOG.md](./CHANGELOG.md).

## How to run the app

1. Install [Node.js](https://nodejs.org/en/download/).
Expand Down
Loading

0 comments on commit dcf58da

Please sign in to comment.