diff --git a/CHANGELOG.md b/CHANGELOG.md index 001a52a..eb42cfc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,16 @@ - # Changelog +# Version 0.0.3 + +- Added support for streaming responses +- Added support for structured data generation +- Added a convenience proc macro (`#[derive(OrchResponseOptions)]`) for generating structured data generation options +- Added support for Open AI + ## Version 0.0.2 No functional changes. ## Version 0.0.1 -Initial release. \ No newline at end of file +Initial release. diff --git a/README.md b/README.md index 4f930ba..82dedce 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ ![Crates.io Version](https://img.shields.io/crates/v/orch) ![Crates.io Total Downloads](https://img.shields.io/crates/d/orch) - `orch` is a library for building language model powered applications and agents for the Rust programming language. It was primarily built for usage in [magic-cli](https://github.com/guywaldman/magic-cli), but can be used in other contexts as well. @@ -11,6 +10,19 @@ It was primarily built for usage in [magic-cli](https://github.com/guywaldman/ma > > If the project gains traction, this can be compiled as an addon to other languages such as Python or a standalone WebAssembly module. +# Installation + +```shell +cargo add orch +``` + +Alternatively, add `orch as a dependency to your `Cargo.toml` file: + +```toml +[dependencies] +orch = "0.0.3" +``` + # Basic Usage ## Simple Text Generation diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..5a65cf6 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,5 @@ +# Release Process + +1. Update the versions in all package `Cargo.toml` files +1. Update the versions in the `README.md` file +1. PR to the `main` branch \ No newline at end of file