plugin: add dataset and resource indexing
This commit is contained in:
20
README.md
20
README.md
@@ -10,3 +10,23 @@ Docs:
|
||||
- `docs/STATUS.md`
|
||||
- `docs/ROADMAP.md`
|
||||
- `docs/REPO_FACTS.json`
|
||||
|
||||
Quickstart:
|
||||
- `python -m afs_scawful datasets index`
|
||||
- `python -m afs_scawful resources index`
|
||||
|
||||
Mounts (AFS Studio):
|
||||
- Create `mounts.json` in `~/.config/afs/afs_scawful/` or `~/.config/afs/plugins/afs_scawful/config/`
|
||||
- Optional override: `AFS_SCAWFUL_MOUNTS=/path/to/mounts.json`
|
||||
- Mount entries are user-specific; keep this file out of version control.
|
||||
|
||||
Example `mounts.json`:
|
||||
```json
|
||||
{
|
||||
"mounts": [
|
||||
{ "name": "Projects", "path": "~/projects" },
|
||||
{ "name": "Training", "path": "~/Mounts/windows-training" },
|
||||
{ "name": "Reference", "path": "~/docs/reference" }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user