Update documentation

CHANGELOG.md

@@ -6,6 +6,7 @@ The versioning scheme is compliant with the [PEP 440] specification.
 
 ## Unreleased
 
+- Renamed the package to `luhncheck` and deprecated the old name.
 - Renamed the `validate` function to `is_luhn`.
 - Dropped support for Python 3.6 and added support for Python 3.11.
 - Fixed location of type-checking marker file.
@@ -38,7 +39,7 @@ The versioning scheme is compliant with the [PEP 440] specification.
 
 ## 1.1.0 (2021-10-20)
 
-- Renamed the project to `luhn-validator` for more generic use.
+- Renamed the project to `luhncheck` for more generic use.
 - Changed `number` parameter of `validate` function to accept integers only.
 - Added `length` and `prefix` parameters to `validate` function.
 - Updated documentation and tests.
@@ -53,7 +54,7 @@ The versioning scheme is compliant with the [PEP 440] specification.
 - Fixed the package homepage URL. ([#2])
 - Updated CI tests to include recent Python versions.
 
-[#2]: https://github.com/dralshehri/luhn-validator/pull/2
+[#2]: https://github.com/dralshehri/luhncheck/pull/2
 
 ## 1.0.5 (2019-06-05)
 

CONTRIBUTING.md

@@ -9,7 +9,7 @@ An issue may be a simple comment, question, feature request, or bug report. When
 [reporting an issue], please make sure to provide enough information to
 understand it.
 
-[reporting an issue]: https://github.com/dralshehri/luhn-validator/issues/new
+[reporting an issue]: https://github.com/dralshehri/luhncheck/issues/new
 
 ## Changing Code
 
@@ -26,7 +26,7 @@ following these simple steps:
 7. Commit and push your changes to your fork.
 8. Create a pull request on GitHub and select the `develop` base branch.
 
-[project repository]: https://github.com/dralshehri/luhn-validator
+[project repository]: https://github.com/dralshehri/luhncheck
 
 ## Developing Locally
 

README.md

@@ -1,24 +1,23 @@
-# luhn-validator
+# luhncheck
 
 A Python package to validate identification numbers using the Luhn algorithm
 with additional optional checks.
 
 <!-- start badges -->
 
-[![Release Status](https://img.shields.io/github/actions/workflow/status/dralshehri/luhn-validator/release.yml?label=release)][release]
+[![Release Status](https://img.shields.io/github/actions/workflow/status/dralshehri/luhncheck/release.yml?label=release)][release]
 [![Coverage Status](https://img.shields.io/badge/coverage-100%25-success)][coverage]
-[![Code Quality](https://img.shields.io/codefactor/grade/github/dralshehri/luhn-validator/main?&label=codefactor)][quality]
-[![PyPI Version](https://img.shields.io/pypi/v/luhn-validator)][pypi-version]
-[![Package License](https://img.shields.io/github/license/dralshehri/luhn-validator)][license]
+[![Code Quality](https://img.shields.io/codefactor/grade/github/dralshehri/luhncheck/main?&label=codefactor)][quality]
+[![PyPI Version](https://img.shields.io/pypi/v/luhncheck)][pypi-version]
+[![Package License](https://img.shields.io/github/license/dralshehri/luhncheck)][license]
 
-[release]:
-  https://github.com/dralshehri/luhn-validator/actions/workflows/release.yml
+[release]: https://github.com/dralshehri/luhncheck/actions/workflows/release.yml
 [coverage]:
-  https://github.com/dralshehri/luhn-validator/actions/workflows/release.yml
+  https://github.com/dralshehri/luhncheck/actions/workflows/release.yml
 [quality]:
-  https://www.codefactor.io/repository/github/dralshehri/luhn-validator/overview/main
-[pypi-version]: https://pypi.python.org/pypi/luhn-validator
-[license]: https://github.com/dralshehri/luhn-validator/blob/main/LICENSE
+  https://www.codefactor.io/repository/github/dralshehri/luhncheck/overview/main
+[pypi-version]: https://pypi.python.org/pypi/luhncheck
+[license]: https://github.com/dralshehri/luhncheck/blob/main/LICENSE
 
 <!-- end badges -->
 
@@ -56,13 +55,13 @@ mistyped or otherwise incorrect numbers.
 To install using `pip`, run:
 
 ```shell
-pip install luhn-validator
+pip install luhncheck
 ```
 
 ## Usage Examples
 
 ```pycon
->>> from luhn_validator import is_luhn
+>>> from luhncheck import is_luhn
 
 >>> # Simple checksum validation
 >>> is_luhn("1101798278")
@@ -83,7 +82,7 @@ True
 
 ## API Reference
 
-### <kbd>function</kbd> `validate`
+### <kbd>function</kbd> `is_luhn`
 
 ```python
 is_luhn(