dev-doc 0.2.0 → 0.2.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 +0 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,17 +12,6 @@ AI-powered codebase analyzer using Claude AI to generate comprehensive documenta
|
|
|
12
12
|
- 📝 **Structured Output**: Generates Markdown or JSON documentation
|
|
13
13
|
- ⚙️ **Highly Configurable**: Customize ignored directories, file extensions, and more
|
|
14
14
|
|
|
15
|
-
## ⚠️ Important Note
|
|
16
|
-
|
|
17
|
-
**This package requires backend infrastructure to function.**
|
|
18
|
-
|
|
19
|
-
Currently, the CLI requires environment variables (`CLAUDE_API_KEY` and `MONGODB_URI`) that must be configured server-side.
|
|
20
|
-
|
|
21
|
-
For a public npm package, you need to:
|
|
22
|
-
1. Deploy a backend API service (see [DEPLOYMENT_ARCHITECTURE.md](./DEPLOYMENT_ARCHITECTURE.md))
|
|
23
|
-
2. Modify the CLI to call your backend API instead of requiring env vars
|
|
24
|
-
|
|
25
|
-
See [DEPLOYMENT_ARCHITECTURE.md](./DEPLOYMENT_ARCHITECTURE.md) for full details.
|
|
26
15
|
|
|
27
16
|
## Installation
|
|
28
17
|
|