Skip to content

Commit

Permalink
Update changelog, README and add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
guywaldman committed Jul 21, 2024
1 parent 35b4e2b commit eb6b706
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Initial release.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,26 @@
![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.

> [!NOTE]
>
> 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
Expand Down
5 changes: 5 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit eb6b706

Please sign in to comment.