README cleanups (#4)

* README cleanups * Add build status * Add crate badge * Dont run double tests on prs
deontologician · Dec 6, 2020 · 697acd0 · 697acd0
1 parent 3383637
commit 697acd0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -1,6 +1,10 @@
-on: [push, pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 
-name: Continuous Integration
+name: CI
 
 jobs:
   check:

diff --git a/README.md b/README.md
@@ -1,18 +1,22 @@
 # 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.
 
 Has a few conveniences, but is mostly at the level of the API itself.
 
 # Installation
 
 ```
-$ cargo add openai-api-rust
+$ cargo add openai-api
 ```
 
 # Quickstart
 
 ```rust
-use openai_api::{api::CompletionArgs, OpenAIClient};
+use openai_api::OpenAIClient;
 
 #[tokio::main]
 async fn main() {