Skip to content

Include latest features into README #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
weak-head merged 5 commits into from
Jan 6, 2025
Merged

Include latest features into README #38

weak-head merged 5 commits into from
Jan 6, 2025

Conversation

@weak-head
Copy link
Owner

@weak-head weak-head commented Jan 6, 2025

Description

Enhances the README to document the following features:

  • Directory Name Parsing: Explains how directory names can be parsed to extract metadata (e.g., author, title, year) when they follow supported patterns.
  • Shorthand Options: Adds usage details for the -d and -b shortcuts, corresponding to --chapters-from-dirs and --bitrate, respectively.
  • Cover Art Integration: Highlights the ability to extract cover art from embedded audio metadata or image files in the source directory.

@weak-head weak-head added the documentation Improvements or additions to documentation label Jan 6, 2025
@weak-head weak-head added this to the 0.3.4 milestone Jan 6, 2025
@weak-head weak-head self-assigned this Jan 6, 2025
@weak-head weak-head merged commit 9c75707 into main Jan 6, 2025
1 check passed
@weak-head weak-head deleted the docs/readme branch January 6, 2025 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@weak-head weak-head

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

0.3.4

Development

Successfully merging this pull request may close these issues.

2 participants

@weak-head