Release v3.1.1

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.1.1] - 2023-06-04
+
+### Changed
+
+- Update `README.md`.
+
 ## [3.1.0] - 2023-06-04
 
 ### Added
@@ -30,5 +36,6 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Initial release.
 
+[3.1.1]: https://github.com/hyugogirubato/pycbzhelper/releases/tag/v3.1.1
 [3.1.0]: https://github.com/hyugogirubato/pycbzhelper/releases/tag/v3.1.0
 [3.0.1]: https://github.com/hyugogirubato/pycbzhelper/releases/tag/v3.0.1

README.md

@@ -1,6 +1,6 @@
 # PyCBZHelper
 
-[![License](https://img.shields.io/github/license/hyugogirubato/pycbzhelper)](https://github.com/hyugogirubato/pycbzhelper/blob/master/LICENSE)
+[![License](https://img.shields.io/github/license/hyugogirubato/pycbzhelper)](https://github.com/hyugogirubato/pycbzhelper/blob/main/LICENSE)
 [![Release](https://img.shields.io/github/release-date/hyugogirubato/pycbzhelper)](https://github.com/hyugogirubato/pycbzhelper/releases)
 [![Latest Version](https://img.shields.io/pypi/v/pycbzhelper)](https://pypi.org/project/pycbzhelper/)
 
@@ -57,8 +57,17 @@ if __name__ == "__main__":
 ````
 
 For more information on how to use PyCBZHelper, please refer to
-the [documentation](https://github.com/hyugogirubato/pycbzhelper/blob/master/docs/schema).
+the [documentation](https://github.com/hyugogirubato/pycbzhelper/blob/main/docs/schema).
+
+### Exceptions
+
+The following exceptions can be raised by PyCBZHelper:
+
+- `InvalidKeyValue`: Raised when a key value is invalid.
+- `MissingPageFile`: Raised when no page files are available.
+- `InvalidFileExtension`: Raised when an invalid file extension is used.
+- `FileNotFound`: Raised when the specified source file is not found.
 
 ### License
 
-This project is licensed under the [GPL v3 License](https://github.com/hyugogirubato/pycbzhelper/blob/master/LICENSE).
+This project is licensed under the [GPL v3 License](https://github.com/hyugogirubato/pycbzhelper/blob/main/LICENSE).

pycbzhelper/__init__.py

@@ -2,4 +2,4 @@ from .helper import *
 from .comicinfo import *
 from .utils import slugify
 
-__version__ = "3.1.0"
+__version__ = "3.1.1"

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="pycbzhelper",
-    version="3.1.0",
+    version="3.1.1",
     author="hyugogirubato",
     author_email="hyugogirubato@gmail.com",
     description="Python library for creating CBZ files with metadata.",