chore: udpate files

haru52 · Mar 31, 2023 · 96b606e · 96b606e
1 parent c5fff48
commit 96b606e
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 35 deletions.
diff --git 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
@@ -1,4 +1,6 @@
-# convertflac: Convert FLAC
+<!-- vale Microsoft.HeadingAcronyms = NO -->
+# convertflac: Convert FLAC CLI
+<!-- vale Microsoft.HeadingAcronyms = YES -->
 
 [![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
diff --git 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
@@ -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
@@ -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": {