Skip to content

Commit 17067e4

Browse files
committed
docs: consolidate documentation structure
- Move ARCHITECTURE.md and RELEASING.md to docs/ - Delete stale listr2 and progress indicators research docs - Update README with release badge, --data-dir docs, fixture commands - Fix architecture link in README
1 parent 0dc5832 commit 17067e4

5 files changed

Lines changed: 11 additions & 790 deletions

File tree

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Libby Downloader
22

33
[![CI](https://github.com/pdugan20/libby-downloader/workflows/CI/badge.svg)](https://github.com/pdugan20/libby-downloader/actions)
4+
[![Release](https://img.shields.io/github/v/release/pdugan20/libby-downloader?logo=github)](https://github.com/pdugan20/libby-downloader/releases)
45
[![Node.js](https://img.shields.io/badge/node-18%2B-green?logo=node.js)](https://nodejs.org)
56
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?logo=opensourceinitiative&logoColor=white)](https://opensource.org/licenses/MIT)
67

@@ -44,27 +45,32 @@ Open an audiobook in Libby, then click the download button in the top-right navi
4445
The CLI provides tagging and merging for downloaded books. Run `libby` for the interactive menu, or use commands directly:
4546

4647
```bash
48+
libby # Interactive menu
49+
libby list # List all downloaded books
4750
libby tag # Tag MP3 files with metadata (interactive)
4851
libby tag ~/path/to/book/ # Tag a specific folder
4952
libby merge # Merge chapters into M4B audiobook (interactive)
5053
libby merge ~/path/to/book/
51-
libby list # List all downloaded books
5254
```
5355

54-
Tag command options: `--title`, `--author`, `--narrator`, `--cover-url`
56+
Options:
57+
58+
- `--data-dir <path>` — Override the downloads directory
59+
- `--title`, `--author`, `--narrator`, `--cover-url` — Override tag metadata
60+
- `--verbose` — Enable debug logging
5561

5662
## Development
5763

5864
```bash
5965
npm run build # Build CLI and extension
60-
npm run build:extension # Build extension only
6166
npm run dev -- list # Run CLI without building
6267
npm run dev:extension # Watch mode for extension
6368
npm run check-all # Full validation (typecheck, lint, format, test)
64-
npm test # Run tests
69+
npm test # Run unit tests
70+
npm run test:cli # Run CLI integration tests against fixtures
6571
```
6672

67-
See [ARCHITECTURE.md](ARCHITECTURE.md) for detailed documentation.
73+
See [docs/architecture.md](docs/architecture.md) for system design and [docs/releasing.md](docs/releasing.md) for the release process.
6874

6975
## Disclaimer
7076

File renamed without changes.

0 commit comments

Comments
 (0)