Skip to content

Commit 2291d28

Browse files
committed
docs: update README with PyPI badge, version, and refresh feature
1 parent 76fa173 commit 2291d28

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
<p align="center">
1717
<a href="https://github.com/onllm-dev/4DPocket/releases/latest"><img src="https://img.shields.io/github/v/release/onllm-dev/4DPocket?label=release&color=blue" alt="Latest Release" /></a>
18+
<a href="https://pypi.org/project/4dpocket/"><img src="https://img.shields.io/pypi/v/4dpocket?color=blue&logo=pypi&logoColor=white" alt="PyPI" /></a>
1819
<a href="https://github.com/onllm-dev/4DPocket/pkgs/container/4dpocket"><img src="https://img.shields.io/badge/ghcr.io-4dpocket-blue?logo=docker" alt="Docker Image" /></a>
1920
<img src="https://img.shields.io/badge/python-3.12+-blue" alt="Python 3.12+" />
2021
<img src="https://img.shields.io/badge/react-19-61DAFB" alt="React 19" />
@@ -55,7 +56,7 @@ Pull the image from GitHub Container Registry:
5556
```bash
5657
docker pull ghcr.io/onllm-dev/4dpocket:latest
5758
# or a specific version:
58-
docker pull ghcr.io/onllm-dev/4dpocket:0.1.0
59+
docker pull ghcr.io/onllm-dev/4dpocket:0.1.4
5960
```
6061

6162
**One-liner (SQLite, no external services):**
@@ -109,7 +110,9 @@ docker compose --profile vectors up -d
109110
docker compose --profile ai --profile search --profile vectors up -d
110111
```
111112

112-
### Python Package
113+
### Python Package (PyPI)
114+
115+
Available on [PyPI](https://pypi.org/project/4dpocket/):
113116

114117
```bash
115118
pip install 4dpocket
@@ -121,6 +124,8 @@ uvicorn fourdpocket.main:app --port 4040
121124
python -m huey.bin.huey_consumer fourdpocket.workers.huey --workers 2
122125
```
123126

127+
> **Note:** The PyPI package name is `4dpocket`, but the Python import remains `fourdpocket` (Python identifiers can't start with a digit).
128+
124129
### From Source (uv)
125130

126131
```bash
@@ -197,6 +202,7 @@ Paste a URL and 4DPocket detects the platform, deeply extracts content, and enri
197202
| **Auto-Tagging** | AI reads content and assigns tags with confidence scores. High-confidence tags applied automatically |
198203
| **Auto-Summarization** | Every item gets a 2-3 sentence AI summary |
199204
| **AI Title Generation** | Generate better titles for notes and items |
205+
| **Content Refresh** | Re-fetch and reprocess any item from its source URL. Manual tags, notes, and collections stay intact |
200206
| **Related Items** | Semantic similarity (0.5) + shared tags (0.3) + same-source (0.2) |
201207
| **Knowledge Gap Analysis** | AI identifies topics you've been collecting but lack depth in |
202208
| **Cross-Platform Insights** | Discover connections between content saved from different platforms |
@@ -338,9 +344,9 @@ URL validation on import, content size caps (1MB content, 50K description), XSS-
338344
- Responsive — mobile (bottom nav), tablet (collapsible sidebar), desktop (full sidebar + shortcuts)
339345
- Dark mode — system-aware with manual toggle (Doraemon Blue theme)
340346

341-
### Chrome Extension
347+
### Chrome Extension (Beta)
342348

343-
Save pages with one click, highlight text on any page, view highlights in a sidebar.
349+
Save pages with one click, highlight text on any page, view highlights in a sidebar. Currently in beta — tested with Google Chrome.
344350

345351
**Install from release:** Download `4dpocket-chrome-extension-*.zip` from the [latest release](https://github.com/onllm-dev/4DPocket/releases/latest), unzip, load in `chrome://extensions` (Developer mode > Load unpacked).
346352

0 commit comments

Comments
 (0)