Skip to content

Commit e9e36e3

Browse files
committed
docs: README adjustments
1 parent ad4690b commit e9e36e3

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🗃️ docs-cache
22

3-
Deterministic local caching of documentation repositories.
3+
Deterministic local caching of external documentation for agents and tools
44

55
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
66
[![npm version](https://img.shields.io/npm/v/docs-cache)](https://www.npmjs.com/package/docs-cache)
@@ -9,9 +9,9 @@ Deterministic local caching of documentation repositories.
99

1010
## Purpose
1111

12-
Provides agents and automation tools with local access to Git-hosted documentation through a deterministic cache.
12+
Provides agents and automation tools with local access to external documentation without committing it to the repository.
1313

14-
Documentation is synced locally, reused when unchanged, and exposed through configurable symlinks for different tools and agents.
14+
Documentation is cached in a gitignored location, exposed to agent and tool targets via links or copies, and updated through sync commands or postinstall hooks.
1515

1616
## Features
1717

@@ -20,6 +20,8 @@ Documentation is synced locally, reused when unchanged, and exposed through conf
2020
- **Fast**: Local cache avoids network roundtrips after sync.
2121
- **Flexible**: Cache full repos or just the subdirectories you need.
2222

23+
> **Note**: Sources are downloaded to a local cache. If you provide a `targetDir`, `docs-cache` creates a symlink or copy from the cache to that target directory. The target should be outside `.docs`.
24+
2325
## Usage
2426

2527
```bash
@@ -95,17 +97,16 @@ npx docs-cache clean
9597
9698
## NPM Integration
9799

98-
Use `postinstall` to ensure docs are ready for local agents immediately after installation in your local project:
100+
Use `postinstall` to ensure documentation is available locally immediately after installation:
99101

100102
```json
101-
// package.json
102103
{
103104
"scripts": {
104105
"postinstall": "docs-cache sync"
105106
}
106107
}
107-
```
108108

109109
## License
110110

111111
MIT
112+
```

0 commit comments

Comments
 (0)