This repository was archived by the owner on Feb 15, 2026. It is now read-only.
Commit 3394ee6
authored
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 pull1 parent 0ea1acc commit 3394ee6
2 files changed
Lines changed: 20 additions & 27 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
12 | 17 | | |
13 | 18 | | |
14 | 19 | | |
| |||
27 | 32 | | |
28 | 33 | | |
29 | 34 | | |
30 | | - | |
| 35 | + | |
31 | 36 | | |
32 | 37 | | |
33 | 38 | | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
52 | | - | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
53 | 43 | | |
54 | 44 | | |
55 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
12 | 17 | | |
13 | 18 | | |
14 | 19 | | |
| |||
27 | 32 | | |
28 | 33 | | |
29 | 34 | | |
30 | | - | |
| 35 | + | |
31 | 36 | | |
32 | 37 | | |
33 | 38 | | |
| |||
49 | 54 | | |
50 | 55 | | |
51 | 56 | | |
52 | | - | |
53 | | - | |
54 | 57 | | |
55 | 58 | | |
56 | 59 | | |
| |||
0 commit comments