Skip to content

Commit 2aa188b

Browse files
authored
Enhance README with additional sections
Expanded the README to include motivation, download instructions, tech stack, and screenshots.
1 parent 39ca444 commit 2aa188b

1 file changed

Lines changed: 53 additions & 8 deletions

File tree

README.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,70 @@
1-
# NoteGrid
2-
31
<p align="center">
42
<img src="assets/banner.png" alt="NoteGrid - Organize your links and tasks">
53
</p>
64

7-
---
8-
95
## What is NoteGrid?
106

11-
NoteGrid is a cross-platform app that helps you manage your todos and links:
7+
NoteGrid is a FOSS cross-platform app that helps you manage your todos and links. It contains:
128

13-
- **Eisenhower Matrix** - Sort tasks by urgency and importance into 4 quadrants: Do, Schedule, Delegate, Eliminate
14-
- **Kanban Board** - Track task progress through stages: Backlog, To Do, In Progress, Done
15-
- **Bookmarks manager** - Save links for later reference.
9+
- **Eisenhower Matrix** - Sort tasks by urgency and importance
10+
- **Kanban Board** - Track task progress through stages of completion
11+
- **Bookmarks manager** - Save links for later reference
1612

1713
All your data syncs automatically across devices.
1814

1915
## No Account Required
2016

2117
NoteGrid uses a unique UUID generated on registering instead of username/password. Store it somewhere safe as it is the only way to access your data:
2218

19+
## Motivation
20+
21+
I wanted a simple productivity app that works cross platform without the bloat of or limitations of basic todo apps
22+
23+
Most productivity apps either:
24+
- Are paid or sell your data to third party
25+
- Force you into their specific workflow
26+
- Are overcomplicated with features
27+
28+
NoteGrid is different: it's simple, no login, works everywhere and free, no questions asked :)
29+
30+
## Download
31+
32+
### Web
33+
34+
Visit [notegrid.pages.dev](https://notegrid.pages.dev)
35+
36+
### Android
37+
38+
1. Download the APK from the [Releases](https://github.com/rsarans/notegrid/releases) page
39+
2. Open the APK on your device
40+
3. If prompted, enable "Install from unknown sources" in Settings
41+
4. Install and open the app
42+
43+
### Chrome Extension
44+
45+
1. Download the `.crx` file from the [Releases](https://github.com/rsarans/notegrid/releases) page
46+
2. Open `chrome://extensions` in Chrome
47+
3. Enable "Developer mode" (toggle in top right)
48+
4. Drag and drop the `.crx` file onto the page, or:
49+
- Click "Load unpacked"
50+
- Select the extracted extension folder
51+
52+
### iOS
53+
54+
Ew apple
55+
56+
## Tech Stack
57+
58+
| Component | Technology |
59+
|-----------|------------|
60+
| Web | React + Vite + Jotai |
61+
| Mobile/Desktop | Flutter |
62+
| Browser Extension | Chrome Extension (Manifest V3) |
63+
| Backend | Hono on Cloudflare Workers |
64+
| Database | Cloudflare R1 |
65+
66+
## Screenshots
67+
2368
### Web
2469

2570
<p>

0 commit comments

Comments
 (0)