-
Notifications
You must be signed in to change notification settings - Fork 141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(readme): New logo & Readme(s) revamp #79
Conversation
interesting, i'm not sure about "By" not being aligned w/ "Playgrounds". Otherwise, it's very nice! @0xMochan |
35ad4f8
to
4df1706
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work! But there are a few things to change. Also, the README example is outdated and should be:
use rig::{completion::Prompt, providers::openai};
#[tokio::main]
async fn main() {
// Create OpenAI client and model
// This requires the `OPENAI_API_KEY` environment variable to be set.
let openai_client = openai::Client::from_env();
let gpt4 = openai_client.agent("gpt-4").build();
// Prompt the model and print its response
let response = gpt4
.prompt("Who are you?")
.await
.expect("Failed to prompt GPT-4");
println!("GPT-4: {response}");
}
(change openai_client.model
to openai_client.agent
)
<a href="https://github.com/0xPlaygrounds/rig?tab=MIT-1-ov-file"><img src="https://img.shields.io/badge/license-MIT-00bfff.svg?color=red" /></a> | ||
<a href="https://twitter.com/Playgrounds0x"><img src="https://img.shields.io/twitter/follow/Playgrounds0x"></a> | ||
<a href="https://docs.rs/rig-core/latest/rig/"><img src="https://img.shields.io/badge/📖documentation-docs.rs-dca282.svg" /></a> | ||
<br> | ||
</p> | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pull request includes updates to configuration files and documentation improvements. The changes primarily focus on updating the
README.md
files for better clarity and adding new badges and examples.For now the rig & playgrounds logos are added as files to the repo. If you agree with the style changes I'll move the files to the rig-site repo and switch to hyperlinks.
Documentation Updates:
README.md
: Updated logo sources, added new badges, improved wording, and added new sections for getting started and integrations. [1] [2] [3]rig-lancedb/README.md
: Updated the introduction with logos and added usage instructions.close https://github.com/0xPlaygrounds/KnowledgeBase/issues/30