Skip to content

Commit 697acd0

Browse files
README cleanups (#4)
* README cleanups * Add build status * Add crate badge * Dont run double tests on prs
1 parent 3383637 commit 697acd0

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

.github/workflows/rust.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
on: [push, pull_request]
1+
on:
2+
pull_request:
3+
push:
4+
branches:
5+
- main
26

3-
name: Continuous Integration
7+
name: CI
48

59
jobs:
610
check:

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# openai-api-rust
2+
![docs](https://docs.rs/openai-api/badge.svg)
3+
[![Crates.io](https://img.shields.io/crates/v/openai-api.svg)](https://crates.io/crates/openai-api)
4+
![build](https://github.com/deontologician/openai-api-rust/workflows/Continuous%20Integration/badge.svg)
5+
26
A simple rust client for OpenAI API.
37

48
Has a few conveniences, but is mostly at the level of the API itself.
59

610
# Installation
711

812
```
9-
$ cargo add openai-api-rust
13+
$ cargo add openai-api
1014
```
1115

1216
# Quickstart
1317

1418
```rust
15-
use openai_api::{api::CompletionArgs, OpenAIClient};
19+
use openai_api::OpenAIClient;
1620

1721
#[tokio::main]
1822
async fn main() {

0 commit comments

Comments
 (0)