You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): improve clarity and add security guidance (#6)
* docs(readme): improve clarity and add security guidance
CHANGES
- Clarify problem statement with concrete AI command examples
- Add Docker commit hash pinning for production security
- Remove redundant sections and sync across README files
- Convert diagrams to mobile-friendly lists in dockerhub version
IMPACT
- Users better understand when to use this tool vs alternatives
- Production deployments can audit container contents for security
- Consistent messaging across GitHub and Docker Hub
* docs(README*.md): add concrete example to pin image to commit hash
* fix(README*.md): correct docker image commit hash tag format
* docs(REAME*.md): remove excess whitespace
* docs(README*.md): add action-oriented comments for docker pull
Copy file name to clipboardExpand all lines: README-dockerhub.md
+12-22Lines changed: 12 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,18 @@
2
2
3
3
> README updated on 2025-07-23 by [@KemingHe](https://github.com/KemingHe)
4
4
5
-
Official docs from `pip`, `poetry`, `uv`, and `conda`+ automated weekly updates = zero maintenance overhead for developers using VSCode/Cursor with AI assistants. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)
5
+
Stop getting out-of-date Python package manager commands from your AI. Cross-reference latest official `pip`, `poetry`, `uv`, and `conda`docs with auto-updates. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)
6
6
7
7
## 🚀 Quick Start for Agentic IDEs
8
8
9
-
**1. Pull latest Docker image**:
9
+
**1. Pull Docker image**:
10
10
11
11
```shell
12
+
# Pin to commit hash for production security
13
+
# Get current hash from: https://hub.docker.com/r/keminghe/py-dep-man-companion/tags
14
+
docker pull keminghe/py-dep-man-companion@sha256:2c896dc617e8cd3b1a1956580322b0f0c80d5b6dfd09743d90859d2ef2b71ec6 # 2025-07-22 release example
**3. Query official docs directly in your AI chat** - guaranteed fresh from weekly automated updates.
35
+
**3. Ask package manager questions** - "How to migrate a `conda` project to `uv`?" and get accurate, current official syntax.
31
36
32
37
## 🔄 Auto-Update Architecture
33
38
34
-
```plaintext
35
-
┌───────────────────────────┐
36
-
│ ⏰ Every Tuesday 6pm ET │
37
-
└─────────────┬─────────────┘
38
-
▼
39
-
┌───────────────────────────┐
40
-
│ 📚 Sync Official Docs │
41
-
└─────────────┬─────────────┘
42
-
▼
43
-
┌───────────────────────────┐
44
-
│ 🔍 Rebuild Search Index │
45
-
└─────────────┬─────────────┘
46
-
▼
47
-
┌───────────────────────────┐
48
-
│ 🐳 Publish Latest Image │
49
-
└───────────────────────────┘
50
-
```
51
-
52
-
**Zero maintenance**: Documentation automatically synced weekly from official sources. Docker `:latest` tag guarantees you always get current docs without manual updates.
Copy file name to clipboardExpand all lines: README.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,18 @@
2
2
3
3
> README updated on 2025-07-23 by [@KemingHe](https://github.com/KemingHe)
4
4
5
-
Official docs from `pip`, `poetry`, `uv`, and `conda`+ automated weekly updates = zero maintenance overhead for developers using VSCode/Cursor with AI assistants. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)
5
+
Stop getting out-of-date Python package manager commands from your AI. Cross-reference latest official `pip`, `poetry`, `uv`, and `conda`docs with auto-updates. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)
6
6
7
7
## 🚀 Quick Start for Agentic IDEs
8
8
9
-
**1. Pull latest Docker image**:
9
+
**1. Pull Docker image**:
10
10
11
11
```shell
12
+
# Pin to commit hash for production security
13
+
# Get current hash from: https://hub.docker.com/r/keminghe/py-dep-man-companion/tags
14
+
docker pull keminghe/py-dep-man-companion@sha256:2c896dc617e8cd3b1a1956580322b0f0c80d5b6dfd09743d90859d2ef2b71ec6 # 2025-07-22 release example
**3. Query official docs directly in your AI chat** - guaranteed fresh from weekly automated updates.
35
+
**3. Ask package manager questions** - "How to migrate a `conda` project to `uv`?" and get accurate, current official syntax.
31
36
32
37
## 🤝 Contributing
33
38
@@ -49,8 +54,6 @@ graph LR
49
54
INDEX --> DOCKER
50
55
```
51
56
52
-
**Zero maintenance**: Documentation automatically synced weekly from official sources. Docker `:latest` tag guarantees you always get current docs without manual updates.
0 commit comments