Skip to content

Commit

Permalink
Update README and transfer the roadmap to a separate file
Browse files Browse the repository at this point in the history
  • Loading branch information
roycechua committed Jan 18, 2024
1 parent 7895e3f commit 1ba1e88
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Just Pomodoro Lite

Just a simple Pomodoro timer
Just a simple Pomodoro timer with PWA support

Remaining features to implement:
Install on your mobile phone and desktop as a stand-alone app

- [x] Responsive Styles
- [ ] Customizability Options
- [ ] Color Theme
- [ ] Message
- [ ] Sound
Roadmap is on [/docs/ROADMAP.md](https://github.com/roycechua/just-pomodoro-lite/docs/ROADMAP.md)

# How to deploy

Expand Down Expand Up @@ -46,3 +42,13 @@ export default {
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

## Generate your own assets

You can use the Vite PWA assets generator here https://vite-pwa-org.netlify.app/assets-generator/cli.html

This is already installed in this repo as a dev dependency

```
npm run generate-pwa-assets
```
17 changes: 17 additions & 0 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# App Roadmap

What can you expect to improved

## Features to implement/TODOs:

- [x] Initial App (timer)
- [x] Responsive Styles
- [x] PWA Support
- [ ] State Persistence (keep track of mode and time)
- [ ] Customizability Options
- [ ] Color Theme
- [ ] Message
- [ ] Sound
- [ ] Automated Tests
- [ ] Final Stability Fixes and Refactors for v1.0
- [ ] Contribution Readiness

0 comments on commit 1ba1e88

Please sign in to comment.