@malikasadjaved/readme-ai 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -23
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](#)
|
|
8
8
|
[](#)
|
|
9
9
|
[](#license)
|
|
10
|
-
[](https://www.npmjs.com/package/readme-ai)
|
|
10
|
+
[](https://www.npmjs.com/package/@malikasadjaved/readme-ai)
|
|
11
11
|
|
|
12
12
|
**One command. Zero install. Beautiful READMEs.**
|
|
13
13
|
|
|
@@ -25,29 +25,29 @@ Unlike existing tools, readme-ai goes deep: it parses dependencies, detects fram
|
|
|
25
25
|
|
|
26
26
|
## Key Features
|
|
27
27
|
|
|
28
|
-
- **npx-first** — zero install, works instantly: `npx readme-ai`
|
|
28
|
+
- **npx-first** — zero install, works instantly: `npx @malikasadjaved/readme-ai`
|
|
29
29
|
- **Deep code analysis** — reads actual source files, extracts functions, endpoints, and CLI commands
|
|
30
30
|
- **Auto Mermaid diagrams** — generates architecture diagrams from your code structure
|
|
31
31
|
- **5 beautiful themes** — Default, Modern, Hacker, Minimal, Academic
|
|
32
32
|
- **4 AI providers** — Claude, GPT-4o, Gemini, Ollama (free & local)
|
|
33
33
|
- **Smart badge generation** — auto-detects language, frameworks, CI, Docker, license
|
|
34
|
-
- **GitHub URL support** — `npx readme-ai github:user/repo` analyzes any public repo
|
|
34
|
+
- **GitHub URL support** — `npx @malikasadjaved/readme-ai github:user/repo` analyzes any public repo
|
|
35
35
|
- **GitHub Action included** — auto-regenerate your README on every push
|
|
36
36
|
|
|
37
37
|
## Quick Start
|
|
38
38
|
|
|
39
39
|
```bash
|
|
40
40
|
# Generate README for current directory
|
|
41
|
-
npx readme-ai
|
|
41
|
+
npx @malikasadjaved/readme-ai
|
|
42
42
|
|
|
43
43
|
# Point at a local project
|
|
44
|
-
npx readme-ai ./my-project
|
|
44
|
+
npx @malikasadjaved/readme-ai ./my-project
|
|
45
45
|
|
|
46
46
|
# Point at a GitHub repo
|
|
47
|
-
npx readme-ai github:expressjs/express
|
|
47
|
+
npx @malikasadjaved/readme-ai github:expressjs/express
|
|
48
48
|
|
|
49
49
|
# Interactive mode (guided prompts)
|
|
50
|
-
npx readme-ai --interactive
|
|
50
|
+
npx @malikasadjaved/readme-ai --interactive
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
## Comparison
|
|
@@ -82,10 +82,10 @@ Numbered sections, citation-style references, formal language. Great for researc
|
|
|
82
82
|
|
|
83
83
|
```bash
|
|
84
84
|
# Use a specific theme
|
|
85
|
-
npx readme-ai --theme modern
|
|
86
|
-
npx readme-ai --theme hacker
|
|
87
|
-
npx readme-ai --theme minimal
|
|
88
|
-
npx readme-ai --theme academic
|
|
85
|
+
npx @malikasadjaved/readme-ai --theme modern
|
|
86
|
+
npx @malikasadjaved/readme-ai --theme hacker
|
|
87
|
+
npx @malikasadjaved/readme-ai --theme minimal
|
|
88
|
+
npx @malikasadjaved/readme-ai --theme academic
|
|
89
89
|
```
|
|
90
90
|
|
|
91
91
|
## AI Providers
|
|
@@ -94,29 +94,29 @@ npx readme-ai --theme academic
|
|
|
94
94
|
|
|
95
95
|
```bash
|
|
96
96
|
export ANTHROPIC_API_KEY=sk-ant-...
|
|
97
|
-
npx readme-ai
|
|
97
|
+
npx @malikasadjaved/readme-ai
|
|
98
98
|
```
|
|
99
99
|
|
|
100
100
|
### GPT-4o-mini (OpenAI)
|
|
101
101
|
|
|
102
102
|
```bash
|
|
103
103
|
export OPENAI_API_KEY=sk-...
|
|
104
|
-
npx readme-ai --provider openai
|
|
104
|
+
npx @malikasadjaved/readme-ai --provider openai
|
|
105
105
|
```
|
|
106
106
|
|
|
107
107
|
### Gemini Flash (Google)
|
|
108
108
|
|
|
109
109
|
```bash
|
|
110
110
|
export GEMINI_API_KEY=...
|
|
111
|
-
npx readme-ai --provider gemini
|
|
111
|
+
npx @malikasadjaved/readme-ai --provider gemini
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
### Ollama (Local, Free)
|
|
115
115
|
|
|
116
116
|
```bash
|
|
117
117
|
# Make sure Ollama is running locally
|
|
118
|
-
npx readme-ai --provider ollama
|
|
119
|
-
npx readme-ai --provider ollama --model llama3.1
|
|
118
|
+
npx @malikasadjaved/readme-ai --provider ollama
|
|
119
|
+
npx @malikasadjaved/readme-ai --provider ollama --model llama3.1
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
## CLI Options
|
|
@@ -147,19 +147,19 @@ Options:
|
|
|
147
147
|
|
|
148
148
|
```bash
|
|
149
149
|
# Generate with Modern theme using OpenAI
|
|
150
|
-
npx readme-ai ./my-app --provider openai --theme modern
|
|
150
|
+
npx @malikasadjaved/readme-ai ./my-app --provider openai --theme modern
|
|
151
151
|
|
|
152
152
|
# Dry run (preview without writing)
|
|
153
|
-
npx readme-ai --dry-run
|
|
153
|
+
npx @malikasadjaved/readme-ai --dry-run
|
|
154
154
|
|
|
155
155
|
# Generate without diagram and badges
|
|
156
|
-
npx readme-ai --no-diagram --no-badges
|
|
156
|
+
npx @malikasadjaved/readme-ai --no-diagram --no-badges
|
|
157
157
|
|
|
158
158
|
# Overwrite existing README and generate GitHub Action
|
|
159
|
-
npx readme-ai --overwrite --action
|
|
159
|
+
npx @malikasadjaved/readme-ai --overwrite --action
|
|
160
160
|
|
|
161
161
|
# Analyze a remote GitHub repository
|
|
162
|
-
npx readme-ai github:tiangolo/fastapi --theme academic
|
|
162
|
+
npx @malikasadjaved/readme-ai github:tiangolo/fastapi --theme academic
|
|
163
163
|
```
|
|
164
164
|
|
|
165
165
|
## GitHub Action
|
|
@@ -168,7 +168,7 @@ Auto-regenerate your README on every push to main:
|
|
|
168
168
|
|
|
169
169
|
```bash
|
|
170
170
|
# Generate the action file automatically
|
|
171
|
-
npx readme-ai --action
|
|
171
|
+
npx @malikasadjaved/readme-ai --action
|
|
172
172
|
```
|
|
173
173
|
|
|
174
174
|
Or manually create `.github/workflows/readme-update.yml`:
|
|
@@ -196,7 +196,7 @@ jobs:
|
|
|
196
196
|
node-version: '20'
|
|
197
197
|
|
|
198
198
|
- name: Generate README
|
|
199
|
-
run: npx readme-ai@latest --overwrite --no-interactive
|
|
199
|
+
run: npx @malikasadjaved/readme-ai@latest --overwrite --no-interactive
|
|
200
200
|
env:
|
|
201
201
|
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
|
|
202
202
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@malikasadjaved/readme-ai",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Generate stunning, production-quality READMEs from any codebase in seconds",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"readme",
|
|
@@ -17,12 +17,12 @@
|
|
|
17
17
|
"homepage": "https://github.com/malikasadjaved/readme-ai",
|
|
18
18
|
"repository": {
|
|
19
19
|
"type": "git",
|
|
20
|
-
"url": "https://github.com/malikasadjaved/readme-ai"
|
|
20
|
+
"url": "git+https://github.com/malikasadjaved/readme-ai.git"
|
|
21
21
|
},
|
|
22
22
|
"license": "MIT",
|
|
23
23
|
"type": "module",
|
|
24
24
|
"bin": {
|
|
25
|
-
"readme-ai": "
|
|
25
|
+
"readme-ai": "dist/index.js"
|
|
26
26
|
},
|
|
27
27
|
"main": "./dist/index.js",
|
|
28
28
|
"files": [
|