diff --git a/README.md b/README.md index 52bf79a..b865899 100644 --- a/README.md +++ b/README.md @@ -2101,17 +2101,17 @@ The Info Vault is a personal learning repository where members save, organize, a | Type | Description | |------|-------------| -| **External URL** | Save any web link with optional full-page HTML cache/snapshot | -| **Internal Reference** | Bookmark to in-platform content (facts, blog posts, books) | -| **Note** | Rich-text notes for personal learning reflections | -| **File Upload** | Upload documents and images (stored in GridFS bucket `vault-files`) | +| **External URL** | Save any web link. Caching stores readable text on the item; an optional full HTML snapshot is written on the server | +| **Internal Reference** | A titled reference item. The API accepts an internal type and id, and the vault form does not send them | +| **Note** | Plain text. The form says Markdown is supported; the reader shows the text as entered | +| **File Upload** | Upload documents and images. Production stores them in the MinIO bucket `vault-files`. GridFS is the local-dev fallback | ### Features -- **Full-page snapshots** — Cache external URLs as complete HTML snapshots for offline access -- **Search & filter** — Full-text search across all vault items with type and category filters +- **Snapshots** — Caching an external URL stores readable text on the item. A full HTML snapshot is optional and saved on the server +- **Search & filter** — Search matches the title, description, notes, cached text, category, tags, and URL. Type and category filters apply to the list, not to search - **Favorites** — Star important items for quick access -- **Stats dashboard** — Item counts by type, storage usage, activity trends +- **Stats dashboard** — Counts by type (URLs, notes, files, references) plus a favorites count - **Parent access** — Parents can browse a child's vault items via `GET /api/vault/child/{childUserId}` ### API Endpoints @@ -2138,7 +2138,7 @@ All endpoints require authentication. |------|---------| | `VaultController.cs` | API controller with CQRS handlers | | `VaultItem.cs` | MongoDB entity (collection: `vault-items`) | -| `GridFsVaultFileService.cs` | GridFS file storage for uploads | +| `GridFsVaultFileService.cs` | Local-dev GridFS fallback. Production uses `S3VaultFileStorageService` and the MinIO bucket `vault-files` | | `info-vault.component.ts` | Angular vault UI with search, filters, favorites | | `vault.service.ts` | Frontend HTTP service |