Update README.md

This commit is contained in:
Sayantan Santra 2023-03-09 09:37:37 -06:00 committed by GitHub
parent 6d94a5429f
commit 64abb5b03b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -26,7 +26,7 @@ sudo make install
- There needs to be a config file named `config` in the `$XDG_CONFIG_HOME/movie-rename/` directory. - There needs to be a config file named `config` in the `$XDG_CONFIG_HOME/movie-rename/` directory.
- It should consist of two lines. The first line should have your [TMDB API key](https://developers.themoviedb.org/3/getting-started/authentication). - It should consist of two lines. The first line should have your [TMDB API key](https://developers.themoviedb.org/3/getting-started/authentication).
- The second line should have a pattern, that will be used for the rename. - The second line should have a pattern, that will be used for the rename.
- In the pattern, the variables need to be enclosed in {{}}, the supported variables are `title`, `year` and `director`. - In the pattern, the variables need to be enclosed in `{}`, the supported variables are `title`, `year` and `director`.
- Default pattern is `{title} ({year}) - {director}`. Extension is always kept. - Default pattern is `{title} ({year}) - {director}`. Extension is always kept.
- Passing `--directory` or `-d` assumes that the arguments are directory names, which contain exactly one movie and optionally subtitles. - Passing `--directory` or `-d` assumes that the arguments are directory names, which contain exactly one movie and optionally subtitles.
- Passing `--dry-run` or `-n` does a dry tun and only prints out the new names, without actually doing anything. - Passing `--dry-run` or `-n` does a dry tun and only prints out the new names, without actually doing anything.