diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bfb616..f7e614f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,13 +2,26 @@ 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.1.0/), and this project -adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +The format is based on [Keep a Changelog], and this project adheres to [Semantic Versioning]. ## [Unreleased] ### Added +### Changed + +### Deprecated + +### Removed + +### Fixed + +### Security + +## \[0.0.2\] - 2024-06-05 + +### Added + - `skar init`: manages the changes to zshrc. Implemented for ZSH only for now. - `skar chat`: opens a chat interface to interact with the AI agent. - `?-`: Alias for `skar chat`. @@ -17,13 +30,22 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - Capture command line arguments without quotes. +### Deprecated + ### Removed -## [0.1.0] - 2024-06-02 +### Fixed -### Added +### Security + +## \[0.0.1\] - 2024-06-02 + +- initial release + + -- Initial implementation of the project. + -[0.1.0]: https://github.com/acovaci/skar/releases/tag/v0.1.0 -[unreleased]: https://github.com/acovaci/skar/compare/v0.1.0...HEAD +[keep a changelog]: https://keepachangelog.com/en/1.0.0/ +[semantic versioning]: https://semver.org/spec/v2.0.0.html +[unreleased]: https://github.com/acovaci/skar/compare/v0.2.0...HEAD diff --git a/Cargo.lock b/Cargo.lock index 4d2aace..a4c37ad 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1213,7 +1213,7 @@ dependencies = [ [[package]] name = "skar" -version = "0.1.0" +version = "0.2.0" dependencies = [ "async-trait", "clap", diff --git a/Cargo.toml b/Cargo.toml index 1806909..e2de8e0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "skar" -version = "0.1.0" +version = "0.2.0" edition = "2021" [dependencies] @@ -18,7 +18,12 @@ reqwest = { version = "0.12.4", features = ["json"] } serde = { version = "1.0.203", features = ["derive"] } text-block-macros = "0.1.1" thiserror = "1.0.61" -tokio = { version = "1.38.0", features = ["rt", "rt-multi-thread", "macros", "io-std"] } +tokio = { version = "1.38.0", features = [ + "rt", + "rt-multi-thread", + "macros", + "io-std", +] } [dev-dependencies] dotenv = "0.15.0" diff --git a/README.md b/README.md index 5039a01..a66cb06 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,15 @@ generate commands for you. ## Installation -You first need to install Rust on your system. You can do this by following the instructions on the -[Rust website](https://www.rust-lang.org/tools/install). +Download the latest release from the [releases page](https://github.com/acovaci/skar/releases) and +extract the archive to where you want to install Skar. You can also clone the repository and build +the project yourself. -Once you have Rust installed, you can install Skar by running the following commands: +On Linux and MacOS, once you have extracted the archive, run the following command to initialize +Skar: ```bash -$ cargo build --release -$ cargo run --release -- init +$ skar init ``` Finally, you will also need to set your OpenAI API key as an environment variable. There are