From 96b606ea885da8c9bf1afc1c00e01b8dffc8a00f Mon Sep 17 00:00:00 2001 From: haru Date: Fri, 31 Mar 2023 23:27:56 +0900 Subject: [PATCH] chore: udpate files --- .github/vale_styles/Vocab/Base/accept.txt | 3 +++ README.md | 25 ++++++++++++++--------- docs/CHANGELOG.md | 13 ------------ docs/CONTRIBUTING.md | 14 ++++++------- docs/SECURITY.md | 6 +++--- package.json | 5 +++-- 6 files changed, 31 insertions(+), 35 deletions(-) delete mode 100644 docs/CHANGELOG.md diff --git a/.github/vale_styles/Vocab/Base/accept.txt b/.github/vale_styles/Vocab/Base/accept.txt index 9472dcd..e9335ae 100644 --- a/.github/vale_styles/Vocab/Base/accept.txt +++ b/.github/vale_styles/Vocab/Base/accept.txt @@ -1,6 +1,9 @@ actionlint +ALAC CBR +Codec Contributing Guideline +Convert FLAC CLI convertflac FFmpeg FLAC diff --git a/README.md b/README.md index d6a3543..4dfe5ee 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# convertflac: Convert FLAC + +# convertflac: Convert FLAC CLI + [![Test](https://github.com/haru52/convertflac/actions/workflows/test.yml/badge.svg)](https://github.com/haru52/convertflac/actions/workflows/test.yml) [![Release](https://github.com/haru52/convertflac/actions/workflows/release.yml/badge.svg)](https://github.com/haru52/convertflac/actions/workflows/release.yml) @@ -8,7 +10,7 @@ ## Overview -convertflac converts FLAC audio files into MP3 files. +convertflac converts FLAC audio files into ALAC or MP3 files. ## Requirements @@ -25,16 +27,19 @@ pip install convertflac ## Usage ```console -Usage: convertflac [OPTIONS] INPUT_DIRECTORY_PATH [OUTPUT_DIRECTORY_PATH] +Usage: convertflac [OPTIONS] INPUT_DIRECTORY_PATH + [OUTPUT_DIRECTORY_PATH] - Convert FLAC audio files into MP3 320kbps CBR files. + Convert FLAC audio files into Apple Lossless Audio Codec (ALAC) or + MP3 320kbps CBR files. Options: - --version Show the version and exit. - -h, --help Show this message and exit. + --version Show the version and exit. + -c, --codec TEXT Set the output codec (alac or mp3. Default: alac). + -h, --help Show this message and exit. ``` -If you don't input `[OUTPUT_DIRECTORY_PATH]`, convertflac makes `mp3` directory in the current directory and sets this `mp3/` as the output directory. +If you don't input `[OUTPUT_DIRECTORY_PATH]`, convertflac makes `alac` or `mp3` directory in the current directory and sets this `alac/` or `mp3/` as the output directory. ## Update @@ -50,10 +55,10 @@ pip uninstall convertflac ## Description -- convertflac converts FLAC audio files into MP3 320kbps CBR files +- convertflac converts FLAC audio files into Apple Lossless Audio Codec (ALAC) or MP3 320kbps CBR files - The output preserves the input directory structure -- The output MP3 files preserve the input FLAC files' metadata -- If a MP3 file with the same name already exists at the output directory, convertflac doesn't overwrite it +- The output ALAC/MP3 files preserve the input FLAC files' metadata +- If an ALAC/MP3 file with the same name already exists at the output directory, convertflac doesn't overwrite it ## Versioning policy diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md deleted file mode 100644 index 2bbe231..0000000 --- a/docs/CHANGELOG.md +++ /dev/null @@ -1,13 +0,0 @@ -## [1.0.1](https://github.com/haru52/convertflac/compare/v1.0.0...v1.0.1) (2023-03-29) - - -### Bug Fixes - -* fix the bug that makes the CLI crash when trying to get the version ([5cc453d](https://github.com/haru52/convertflac/commit/5cc453db8ebf9674ab081067226f8a850f023522)) - -## 1.0.0 (2023-03-29) - - -### Features - -* release initial version (v1.0.0) ([7022fd6](https://github.com/haru52/convertflac/commit/7022fd66a026555c2f8c7dd382da82f2268e815e)) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c6b52c0..3c6a8be 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,16 +2,16 @@ ## Requirements -| Tool | Version | -| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| Tool | Version | +| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | Node.js | [.node-version](https://github.com/haru52/convertflac/blob/main/.node-version#L1) | | npm | `engines.npm` value in [package.json](https://github.com/haru52/convertflac/blob/main/package.json) | -| [gibo](https://github.com/simonwhitaker/gibo#readme) | ^2.2.8 | -| [Vale CLI](https://vale.sh/) | ^2.24.0 | -| [yamllint](https://yamllint.readthedocs.io/) | ^1.30.0 | -| [ShellCheck](https://github.com/koalaman/shellcheck#readme) | >=0.9.0 <1.0.0 | +| [gibo](https://github.com/simonwhitaker/gibo#readme) | ^2.2.8 | +| [Vale CLI](https://vale.sh/) | ^2.24.0 | +| [yamllint](https://yamllint.readthedocs.io/) | ^1.30.0 | +| [ShellCheck](https://github.com/koalaman/shellcheck#readme) | >=0.9.0 <1.0.0 | | [actionlint](https://github.com/rhysd/actionlint#readme) | [.tool-versions](https://github.com/haru52/convertflac/blob/main/.tool-versions) | -| Pipenv | >=2023.3.20 | +| Pipenv | >=2023.3.20 | ## Rules diff --git a/docs/SECURITY.md b/docs/SECURITY.md index c3eb7f4..50ace51 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -3,10 +3,10 @@ ## Supported Versions -| Version | Supported | -| ------------------------------------------------------------- | --------- | +| Version | Supported | +| --------------------------------------------------------------- | --------- | | [Latest](https://github.com/haru52/convertflac/releases/latest) | ✅ | -| Others | ❌ | +| Others | ❌ | ## Reporting a Vulnerability diff --git a/package.json b/package.json index 31852d5..ae647d7 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "convertflac", "version": "0.1.0", - "description": "Convert FLAC audio files into MP3 files.", + "description": "Convert FLAC audio files into ALAC or MP3 files.", "private": true, "engines": { "node": "^18.15.0", @@ -27,9 +27,10 @@ }, "keywords": [ "audio", - "encoder", "converter", + "encoder", "flac", + "alac", "mp3" ], "author": {