Update README.md to include To-Do list and prerequisites for pnpm

- Added a To-Do section outlining future enhancements such as reading time and UI/UX cleanup.
- Updated prerequisites to include pnpm 9+ for consistency in dependency management.
This commit is contained in:
2025-12-27 12:25:50 -06:00
parent 3258ee94cf
commit 30b5f48349

View File

@@ -25,14 +25,24 @@ Web News follows a "zero-knowledge" philosophy:
3. **Local Cache**: Full-text content is cached locally in IndexedDB for offline reading and instant access.
4. **Hardened Backend**: Built-in bot blocking, rate limiting, and secure token generation.
## To-DO
- [ ] Reading time
- [ ] UI/UX Cleanup
- [ ] Add feed fetching timeout and button to remove if failed 3 times
- [ ] Use Go Mobile, remove Java RSS plugin.
## Getting Started
### Prerequisites
- Go 1.21+
- Node.js 18+
- pnpm 9+
- [Wails CLI](https://wails.io/docs/gettingstarted/installation) (for desktop builds)
### Build & Run (Web Server)
1. **Build the binary**:
```bash
make build
@@ -43,6 +53,7 @@ Web News follows a "zero-knowledge" philosophy:
```
### Build & Run (Desktop App)
1. **Launch Dev Mode**:
```bash
make desktop-dev
@@ -60,12 +71,14 @@ Web News follows a "zero-knowledge" philosophy:
## Configuration
### Server Flags
- `--auth-mode`: `none` (default), `token`, or `multi`.
- `--allow-registration`: Allow generating new account numbers (default: true).
- `--auth-file`: Path to the account storage (default: `accounts.json`).
- `--port`: Port to listen on (default: `8080`).
### Keyboard Shortcuts (Default)
- `j` / `k`: Next / Previous article
- `r`: Mark as read
- `s`: Toggle save
@@ -75,7 +88,7 @@ Web News follows a "zero-knowledge" philosophy:
## Development
- **Dev Server**: `make dev` (Starts Go backend + Vite frontend)
- **Format & Lint**: `npm run format && npm run lint`
- **Format & Lint**: `pnpm run format && pnpm run lint`
- **Clean Artifacts**: `make clean`
## License
@@ -83,4 +96,5 @@ Web News follows a "zero-knowledge" philosophy:
MIT - See [LICENSE](LICENSE) for details.
---
Created by [Quad4](https://quad4.io)