From 383f8981250d2fe646b4f642b36b28b3dbdd178f Mon Sep 17 00:00:00 2001 From: MAZE Date: Tue, 30 Apr 2024 15:46:53 +0330 Subject: [PATCH] chore: update README file --- README.md | 50 ++++++++++++++++++++++++++------------------------ 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 602de67..792b7f4 100644 --- a/README.md +++ b/README.md @@ -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