📝 Update README with badges

shroominic · Oct 23, 2023 · 0224011 · 0224011
1 parent e1e171d
commit 0224011
Showing 1 changed file with 10 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,11 @@
 # CodeBox
 
+[![Version](https://badge.fury.io/py/codeboxapi.svg)](https://badge.fury.io/py/codeboxapi)
+[![code-check](https://github.com/shroominic/codebox-api/actions/workflows/code-check.yml/badge.svg)](https://github.com/shroominic/codebox-api/actions/workflows/code-check.yml)
+![Downloads](https://img.shields.io/pypi/dm/codeboxapi)
+![License](https://img.shields.io/pypi/l/codeboxapi)
+![PyVersion](https://img.shields.io/pypi/pyversions/codeboxapi)
+
 CodeBox is the simplest cloud infrastructure for your LLM Apps and Services.
 It allows you to run python code in an isolated/sandboxed environment.
 Additionally, it provides simple fileIO (and vector database support coming soon).
@@ -14,13 +20,13 @@ pip install codeboxapi
 
 ## Usage
 
-```python
-# Make sure to set the api-key as environment variable:
-# CODEBOX_API_KEY=sk-*******************************
+```bash
+export CODEBOX_API_KEY=sk-***************
+```
 
+```python
 from codeboxapi import CodeBox
 
-
 # startup and automatically shutdown a new codebox
 with CodeBox() as codebox:
     # check if it's running
@@ -40,7 +46,6 @@ with CodeBox() as codebox:
 ## Where to get your api-key?
 
 CodeBox is currently in early development so I created a stripe [payment link as login](https://pay.codeboxapi.com/b/00g3e6dZX2fTg0gaEE) system.
-As BetaTester you get 70% with the code `BETA`.
 Bear in mind, we don't have many automations set up right now,
 so you'll need to write an [email](mailto:contact@codeboxapi.com) for things like refunds,
 sub cancellations, or upgrades.