Skip to content

Commit b92606c

Browse files
JOHNJOHN
authored andcommitted
Merge branch 'fix/phase4-technical-debt'
2 parents f847fc9 + 0968aef commit b92606c

File tree

1 file changed

+44
-42
lines changed

1 file changed

+44
-42
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 44 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
# Graphiti - Pubky URL Tagger 🎨
1+
# Graphiti - Pubky URL Tagger
22

3-
A powerful Chrome extension that lets you **draw graffiti on web pages**, create text annotations, bookmark URLs, and share everything through the decentralized Pubky network. All your data syncs to your personal Pubky homeserver - no third-party tracking!
3+
A powerful Chrome extension that lets you draw graffiti on web pages, create text annotations, bookmark URLs, and share everything through the decentralized Pubky network. All your data syncs to your personal Pubky homeserver - no third-party tracking!
44

55
[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/BitcoinErrorLog/graphiti)
66
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
77

8-
## ✨ Features
8+
## Features
9+
10+
### Drawing Mode
911

10-
### 🎨 **Drawing Mode**
1112
Draw graffiti directly on any webpage with a persistent canvas overlay:
1213
- **8-color palette** for vibrant drawings
1314
- **Adjustable brush thickness** (2-20px)
@@ -23,7 +24,8 @@ Draw graffiti directly on any webpage with a persistent canvas overlay:
2324
- Create visual notes on articles
2425
- Collaborative web graffiti (with shared URLs)
2526

26-
### πŸ“ **Text Annotations**
27+
### Text Annotations
28+
2729
Highlight text and add comments that persist:
2830
- Select any text on a page
2931
- Add detailed comments and notes
@@ -32,23 +34,26 @@ Highlight text and add comments that persist:
3234
- Click annotations to scroll to highlighted text
3335
- Search and filter your annotations
3436

35-
### πŸ”– **Bookmarks & Tags**
37+
### Bookmarks & Tags
38+
3639
Organize and share your favorite content:
3740
- One-click bookmarking
3841
- Add custom tags to any URL
3942
- Bookmarks sync to Pubky homeserver
4043
- Tag-based discovery
4144
- View bookmarks from people you follow
4245

43-
### πŸ“± **Social Feed**
46+
### Social Feed
47+
4448
See what your network is sharing:
4549
- View posts about the current page
4650
- See bookmarks and annotations from followed users
4751
- Chronological feed with real-time updates
4852
- Post your own content with tags
4953
- Engage with your decentralized network
5054

51-
### πŸ” **Privacy-First Authentication & Key Management**
55+
### Privacy-First Authentication & Key Management
56+
5257
Secure QR-based authentication with key backup:
5358
- Scan QR code with Pubky Ring mobile app
5459
- No passwords, no tracking
@@ -57,15 +62,16 @@ Secure QR-based authentication with key backup:
5762
- **Recovery file export** - Backup your keys with encrypted recovery files
5863
- Full control over your identity
5964

60-
### πŸ› οΈ **Developer Tools**
65+
### Developer Tools
66+
6167
Built-in debugging and monitoring:
6268
- Real-time log viewer
6369
- Export logs for troubleshooting
6470
- Filter by log level
6571
- Performance monitoring
6672
- Clear console interface
6773

68-
## πŸš€ Quick Start
74+
## Quick Start
6975

7076
### Installation (For Users)
7177

@@ -76,7 +82,7 @@ Built-in debugging and monitoring:
7682
4. Enable "Developer mode" (toggle in top-right)
7783
5. Click "Load unpacked"
7884
6. Select the extracted folder (not the zip file itself)
79-
7. Done! πŸŽ‰
85+
7. Done!
8086

8187
**Note:** The zip file contains the pre-built extension. You don't need to build it yourself.
8288

@@ -102,7 +108,7 @@ npm run build
102108
3. **Navigate to any website** (e.g., https://example.com)
103109
4. **Try drawing mode** - Press `Alt+D` and start drawing!
104110

105-
## ⌨️ Keyboard Shortcuts
111+
## Keyboard Shortcuts
106112

107113
| Shortcut | Action | Description |
108114
|----------|--------|-------------|
@@ -120,13 +126,13 @@ npm run build
120126

121127
**Tip:** Press `Shift+?` in the popup or sidepanel to see all available shortcuts!
122128

123-
## πŸ“– Usage Guide
129+
## Usage Guide
124130

125131
### Drawing on Web Pages
126132

127133
**Activate Drawing Mode:**
128134
1. Navigate to any webpage
129-
2. Press `Alt+D` (or click 🎨 in popup)
135+
2. Press `Alt+D` (or click Drawing button in popup)
130136
3. A toolbar appears in the top-right corner
131137

132138
**Drawing Controls:**
@@ -167,12 +173,12 @@ npm run build
167173
**Bookmark a Page:**
168174
1. Navigate to the page
169175
2. Click the extension icon
170-
3. Click "Bookmark Page" or "β˜†"
176+
3. Click "Bookmark Page" or star icon
171177
4. Bookmark saves locally and syncs to Pubky
172178

173179
**Remove Bookmark:**
174180
1. Click the extension icon
175-
2. If already bookmarked, click "⭐ Bookmarked"
181+
2. If already bookmarked, click "Bookmarked"
176182
3. Bookmark is removed
177183

178184
### Tagging & Posting
@@ -193,7 +199,7 @@ npm run build
193199

194200
**Open Feed:**
195201
1. Click the extension icon
196-
2. Click "πŸ“± View Feed"
202+
2. Click "View Feed"
197203
3. Side panel opens on the right
198204

199205
**Feed Tabs:**
@@ -205,22 +211,22 @@ npm run build
205211

206212
**Edit Your Profile:**
207213
1. Click the extension icon
208-
2. Click "✏️ Edit Profile"
214+
2. Click "Edit Profile"
209215
3. Update your name, bio, avatar, status, and links
210216
4. Click "Save Profile" to sync to your homeserver
211217

212218
**Export Recovery File (Key Backup):**
213219
1. Click the extension icon
214-
2. Click "✏️ Edit Profile"
220+
2. Click "Edit Profile"
215221
3. Scroll to "Key Backup" section
216-
4. Click "πŸ” Export Recovery File"
222+
4. Click "Export Recovery File"
217223
5. Enter a strong passphrase (min 8 chars, letters + numbers)
218224
6. Confirm the passphrase
219225
7. File downloads automatically (`pubky-recovery-YYYY-MM-DD.recovery`)
220226

221227
**Important:** Store your recovery file securely! You'll need it and your passphrase to restore your keys if you lose access to your device.
222228

223-
## πŸ—οΈ Architecture
229+
## Architecture
224230

225231
### Technology Stack
226232

@@ -297,7 +303,7 @@ graphiti/
297303
- Annotation browser
298304
- Tab-based navigation
299305

300-
## πŸ”Œ Pubky Integration
306+
## Pubky Integration
301307

302308
### Data Storage Locations
303309

@@ -381,7 +387,7 @@ All data syncs to your Pubky homeserver:
381387
}
382388
```
383389

384-
## πŸ› οΈ Development
390+
## Development
385391

386392
### Prerequisites
387393

@@ -393,7 +399,7 @@ All data syncs to your Pubky homeserver:
393399

394400
```bash
395401
# Clone repository
396-
git clone https://github.com/yourusername/graphiti.git
402+
git clone https://github.com/BitcoinErrorLog/graphiti.git
397403
cd graphiti
398404

399405
# Install dependencies
@@ -445,15 +451,15 @@ See [docs/TESTING.md](docs/TESTING.md) for detailed test documentation.
445451
3. Test each feature:
446452
- Drawing mode (`Alt+D`)
447453
- Annotations (select text)
448-
- Bookmarks (click β˜†)
454+
- Bookmarks (click star icon)
449455
- Tags (add in popup)
450456
- Feed (view sidebar)
451457

452458
**Console Debugging:**
453459
- Open DevTools (F12)
454460
- Look for "[Graphiti]" log messages
455461
- Check for errors in red
456-
- Use "πŸ”§ Debug" panel in popup
462+
- Use "Debug" panel in popup
457463

458464
### Adding New Features
459465

@@ -480,7 +486,7 @@ See [docs/TESTING.md](docs/TESTING.md) for detailed test documentation.
480486
3. Return appropriate response
481487
4. Test with `chrome.runtime.sendMessage`
482488

483-
## πŸ› Troubleshooting
489+
## Troubleshooting
484490

485491
### Drawing Mode Issues
486492

@@ -517,7 +523,7 @@ See [docs/TESTING.md](docs/TESTING.md) for detailed test documentation.
517523
- Verify you're signed in
518524
- Check Pubky homeserver is accessible
519525
- Look for sync errors in console
520-
- Check "πŸ”§ Debug" panel for details
526+
- Check "Debug" panel for details
521527

522528
**Annotations not appearing:**
523529
- Refresh the page
@@ -529,7 +535,7 @@ See [docs/TESTING.md](docs/TESTING.md) for detailed test documentation.
529535

530536
Enable detailed logging:
531537
1. Open popup
532-
2. Click "πŸ”§ Debug"
538+
2. Click "Debug"
533539
3. View all extension activity
534540
4. Filter by context or level
535541
5. Export logs if needed
@@ -542,15 +548,15 @@ Look for these log contexts:
542548
- `PubkyAPISDK` - API calls
543549
- `Auth` - Authentication
544550

545-
## πŸ“ Known Limitations
551+
## Known Limitations
546552

547553
1. **Drawing viewport-dependent** - Drawings match viewport size at creation
548554
2. **Chrome/Edge only** - Manifest V3 required
549555
3. **No mobile support** - Desktop browser extension only
550556
4. **Content script required** - Some pages block content scripts
551557
5. **Drawing on scroll disabled** - Prevents misalignment issues
552558

553-
## πŸ—ΊοΈ Roadmap
559+
## Roadmap
554560

555561
### Near-Term
556562
- [ ] Eraser tool for drawings
@@ -576,7 +582,7 @@ Look for these log contexts:
576582
- [ ] Advanced search and filters
577583
- [ ] Analytics dashboard
578584

579-
## 🀝 Contributing
585+
## Contributing
580586

581587
Contributions are welcome! Here's how:
582588

@@ -597,32 +603,28 @@ Contributions are welcome! Here's how:
597603
- Write clear commit messages
598604
- Keep PRs focused and small
599605

600-
## πŸ“„ License
606+
## License
601607

602608
MIT License - see [LICENSE](LICENSE) file for details
603609

604-
## πŸ™ Acknowledgments
610+
## Acknowledgments
605611

606612
- **Pubky Protocol** - Decentralized identity and storage
607613
- **Pubky Team** - For the innovative protocol and SDK
608614
- **Open Source Community** - For amazing tools and libraries
609615

610-
## πŸ“ž Support & Documentation
616+
## Support & Documentation
611617

612618
- **Issues:** [GitHub Issues](https://github.com/BitcoinErrorLog/graphiti/issues)
613619
- **Documentation:** See `/docs` folder for detailed technical documentation
614620
- **Features:** See [FEATURES.md](FEATURES.md) for complete feature documentation
615621
- **Security:** See [SECURITY.md](SECURITY.md) for security information
616622
- **Contributing:** See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines
617623
- **Changelog:** See [CHANGELOG.md](CHANGELOG.md) for version history
618-
- **Debug:** Use built-in debug panel in extension (click πŸ”§ in popup)
619-
620-
## 🌟 Star History
621-
622-
If you find Graphiti useful, please star the repository!
624+
- **Debug:** Use built-in debug panel in extension (click Debug in popup)
623625

624626
---
625627

626-
**Made with ❀️ for the decentralized web**
628+
**Made with care for the decentralized web**
627629

628-
🎨 Draw freely, annotate wisely, share openly
630+
Draw freely, annotate wisely, share openly

0 commit comments

Comments
Β (0)