chore: prerelease (#14)

Cargo.toml

@@ -5,9 +5,9 @@ edition = "2021"
 license = "MIT"
 
 authors = ["Felipe S. S. Schneider <schneider.felipe.5@gmail.com>"]
-description = "Urban broccoli"
+description = "echo \"It's dangerous to go alone\" | ellie"
 repository = "https://github.com/schneiderfelipe/ellie"
-documentation = "https://docs.rs/ellie"
+# documentation = "https://docs.rs/ellie"
 rust-version = "1.72.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -2,48 +2,16 @@
 
 [![Build Status]][actions]
 [![Latest Version]][crates.io]
-[![Documentation]][docs.rs]
 
-Urban broccoli.
-
-## Draft
-
-This is how ellie will work when complete:
+<!-- [![Documentation]][docs.rs] -->
 
 ```console
-$ echo Tell me a joke | ellie
-Q: Why did the tomato turn red?
-A: Because it saw the salad dressing!
+$ echo "It's dangerous to go alone" | ellie
+Take this!
 ```
 
-ellie is a suckless,
-opinionated,
-text-in-text-out command-line application.
-
-ellie chooses models for you.
-ellie chooses system messages for you.
-ellie chooses temperature for you.
-ellie chooses top p for you.
-ellie chooses maximum number of tokens for you.
-ellie chooses stop sequences for you.
-
-### Inner workings
-
-ellie makes decisions in a simplified matter,
-so that you don't have to.
-ellie is simple,
-and should simply work.
-
-It makes decisions based on its input,
-prepares a request based on it,
-processes the request,
-gets a response,
-and gives you an answer in the end.
-
-ellie uses
-
-- [async-openai](https://crates.io/crates/async-openai)
-- [tiktoken-rs](https://crates.io/crates/tiktoken-rs)
+ellie is a Rust-based command-line interface to ChatGPT,
+featuring support for function calling through external providers.
 
 ## Functions
 
@@ -137,7 +105,7 @@ refer to the [OpenAI official guide](https://platform.openai.com/docs/guides/gpt
 
 ## Detailed output
 
-**TL;DR**: use logging.
+**TL;DR**: use logging for now.
 
 If you just want to see functions being called,
 use `RUST_LOG=info`: