diff --git a/CHANGELOG.md b/CHANGELOG.md index 48dd86d..10d88a2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Changelog +## [0.3.5] - 2024-04-09 + +### Changed + +- Update minimum `crystal` version to `~> 1.11.0` ([#270](https://github.com/athena-framework/athena/pull/270)) (George Dietrich) +- Integrate website into monorepo ([#365](https://github.com/athena-framework/athena/pull/365)) (George Dietrich) + +### Added + +- Support for Windows OS ([#270](https://github.com/athena-framework/athena/pull/270)) (George Dietrich) + +### Fixed + +- Fix incorrect column/width `ACON::Terminal` values on Windows ([#361](https://github.com/athena-framework/athena/pull/361)) (George Dietrich) + ## [0.3.4] - 2023-10-10 ### Added @@ -106,6 +121,7 @@ _First release a part of the monorepo._ _Initial release._ +[0.3.5]: https://github.com/athena-framework/console/releases/tag/v0.3.5 [0.3.4]: https://github.com/athena-framework/console/releases/tag/v0.3.4 [0.3.3]: https://github.com/athena-framework/console/releases/tag/v0.3.3 [0.3.2]: https://github.com/athena-framework/console/releases/tag/v0.3.2 diff --git a/README.md b/README.md index be22b7c..21b1ae6 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,9 @@ Allows for the creation of CLI based commands. -## Installation +## Getting Started -1. Add the dependency to your `shard.yml`: - -```yaml -dependencies: - athena-console: - github: athena-framework/console - version: ~> 0.3.0 -``` - -2. Run `shards install` - -## Documentation - -If using the component on its own, checkout the [API documentation](https://athenaframework.org/Console). -If using the component as part of Athena, also checkout the [external documentation](https://athenaframework.org/architecture/console). +Checkout the [Documentation](https://athenaframework.org/Console). ## Contributing diff --git a/docs/README.md b/docs/README.md index 2821778..e418963 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,7 +10,7 @@ First, install the component by adding the following to your `shard.yml`, then r dependencies: athena-console: github: athena-framework/console - version: ~> 0.3.0 + version: ~> 0.3.5 ``` ## Usage diff --git a/shard.yml b/shard.yml index 8179d12..f914f39 100644 --- a/shard.yml +++ b/shard.yml @@ -1,6 +1,6 @@ name: athena-console -version: 0.3.4 +version: 0.3.5 crystal: ~> 1.11 diff --git a/src/athena-console.cr b/src/athena-console.cr index 36e9cef..d9e5d89 100644 --- a/src/athena-console.cr +++ b/src/athena-console.cr @@ -28,7 +28,7 @@ alias ACONA = ACON::Annotations # Allows the creation of CLI based commands module Athena::Console - VERSION = "0.3.4" + VERSION = "0.3.5" # Contains all the `Athena::Console` based annotations. module Annotations; end