hax/moodist
1
0
Fork 0
mirror of https://github.com/remvze/moodist.git synced 2025-12-17 08:54:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update README file

Browse source
This commit is contained in:
MAZE 2024-04-30 15:46:53 +03:30
parent 8d90344b26
commit 383f898125
1 changed files with 26 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

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