chore: update README file

This commit is contained in:
MAZE 2024-04-30 15:46:53 +03:30
parent 8d90344b26
commit 383f898125

View file

@ -7,17 +7,18 @@
## Features
- 🎵 Over 75 ambient sounds
- 📝 Persistent sound selection
- ✈️ Sharing sound selections with others
- 🧰 Custom sound presets
- 🌙 Sleep timer for sounds (soon)
- 📓 Notepad for quick notes
- ⌛ Pomodoro timer
- ✅ Simple to-do list (soon)
- ⌨️ Keyboard shortcuts for everything
- 🥷 Privacy focused: no data collection
- 💰 Completely free, open-source, and self-hostable
1. 🎵 Over 75 ambient sounds
1. 📝 Persistent sound selection
1. ✈️ Sharing sound selections with others
1. 🧰 Custom sound presets
1. 🌙 Sleep timer for sounds (soon)
1. 📓 Notepad for quick notes
1. 🍅 Pomodoro timer
1. ✅ Simple to-do list (soon)
1. ⌛ Distraction-free countdown timer (soon)
1. ⌨️ Keyboard shortcuts for everything
1. 🥷 Privacy focused: no data collection
1. 💰 Completely free, open-source, and self-hostable
## Tools
@ -26,6 +27,7 @@
- 🧑‍🚀 **Astro**: Meta Framework
- 🎨 **CSS Modules**: Styling
- 🐻 **Zustand**: State Management
- 🎭 **Framer Motion**: Animation Library
- ⚙️ **Radix**: Accessible Components
- 📕 **Storybook**: Component Documentation
- 🧪 **Vitest**: Unit Testing (soon)
@ -42,19 +44,19 @@
## Commands
- `npm run dev`: run development server
- `npm run build`: build for production
- `npm run preview`: preview the built app
- `npm run lint`: lint files using ESLint
- `npm run lint:fix`: lint and fix using ESLint
- `npm run lint:style`: lint styles using Stylelint
- `npm run lint:style:fix`: lint and fix styles using Stylelint
- `npm run format`: format files using Prettier
- `npm run commit`: commit message using Commitizen
- `npm run release:major`: release major varsion
- `npm run release:minor`: release minor varsion
- `npm run release:patch`: release patch varsion
- `npm run storybook`: run Storybook
- `npm run **dev**`: run development server
- `npm run **build**`: build for production
- `npm run **preview**`: preview the built app
- `npm run **lint**`: lint files using ESLint
- `npm run **lint:fix**`: lint and fix using ESLint
- `npm run **lint:style**`: lint styles using Stylelint
- `npm run **lint:style:fix**`: lint and fix styles using Stylelint
- `npm run **format**`: format files using Prettier
- `npm run **commit**`: commit message using Commitizen
- `npm run **release:major**`: release major varsion
- `npm run **release:minor**`: release minor varsion
- `npm run **release:patch**`: release patch varsion
- `npm run **storybook**`: run Storybook
## License