debt: Refactored documentation to improve readability and clarity.

CHANGELOG/CHANGELOG-1.x.md

@@ -15,6 +15,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
+---
+## [1.17.3] - 2024-NOV-14
+
+### Added
+### Changed
+- **DEBT:** Refactored documentation to improve readability and clarity.
+### Deprecated
+### Removed
+### Fixed
+### Security
+
 ---
 ## [1.17.2] - 2024-NOV-12
 
@@ -398,7 +409,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/sixafter/nanoid/compare/v1.17.2..HEAD
+[Unreleased]: https://github.com/sixafter/nanoid/compare/v1.17.3..HEAD
+[1.17.3]: https://github.com/sixafter/nanoid/compare/v1.17.2...v1.17.3
 [1.17.2]: https://github.com/sixafter/nanoid/compare/v1.17.1...v1.17.2
 [1.17.1]: https://github.com/sixafter/nanoid/compare/v1.17.0...v1.17.1
 [1.17.0]: https://github.com/sixafter/nanoid/compare/v1.16.1...v1.17.0

README.md

@@ -31,11 +31,15 @@ Please see the [godoc](https://pkg.go.dev/github.com/sixafter/nanoid) for detail
   - The Nano ID generator now satisfies the `io.Reader` interface, allowing it to be used interchangeably with any `io.Reader` implementations. 
   - Developers can now utilize the Nano ID generator in contexts such as streaming data processing, pipelines, and other I/O-driven operations.
 
+Please see the [Nano ID CLI](https://github.com/sixafter/nanoid-cli) for a command-line interface (CLI) that uses this package to generate Nano IDs.
+
 ---
 
 ## Installation
 
-To install the package, use:
+### Using `go get`
+
+To install the Nano ID package, run the following command:
 
 ```sh
 go get -u github.com/sixafter/nanoid