GabrielTofvesson/openai-api-rust
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README cleanups (#4)

Browse Source 
* README cleanups

* Add build status

* Add crate badge

* Dont run double tests on prs
This commit is contained in:
Josh Kuhn 2020-12-05 17:44:06 -08:00 committed by GitHub
parent 3383637f24
commit 697acd0a0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/workflows/rust.yml vendored
View File

@ -1,6 +1,10 @@
on: [push, pull_request] on:
pull_request:
push:
branches:
- main
name: Continuous Integration name: CI
jobs: jobs:
check: check:

8
README.md
View File

@ -1,4 +1,8 @@
# openai-api-rust # openai-api-rust
![docs](https://docs.rs/openai-api/badge.svg)
[![Crates.io](https://img.shields.io/crates/v/openai-api.svg)](https://crates.io/crates/openai-api)
![build](https://github.com/deontologician/openai-api-rust/workflows/Continuous%20Integration/badge.svg)
A simple rust client for OpenAI API. A simple rust client for OpenAI API.
Has a few conveniences, but is mostly at the level of the API itself. Has a few conveniences, but is mostly at the level of the API itself.
@ -6,13 +10,13 @@ Has a few conveniences, but is mostly at the level of the API itself.
# Installation # Installation
``` ```
$ cargo add openai-api-rust $ cargo add openai-api
``` ```
# Quickstart # Quickstart
```rust ```rust
use openai_api::{api::CompletionArgs, OpenAIClient}; use openai_api::OpenAIClient;
#[tokio::main] #[tokio::main]
async fn main() { async fn main() {