From 646b6a25559a5457ee4da4c8d4ee7e747cb38c60 Mon Sep 17 00:00:00 2001
From: Zev Averbach <zev@averba.ch>
Date: Sun, 2 Apr 2023 23:11:17 +0200
Subject: [PATCH] readme

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index 556bf06..c4a5b39 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,28 @@
+# A CLI for Requesting AI-Generated Things!
+
+## Installation
+
+`pip install ai_getter`
+
+## Usage
+
+```bash
+   aig help
+   aig image <prompt> [--clip] --num-images <num_images> [--save-path <path>] [--s3]
+   aig text <prompt> [--clip] [--save-path <path>] [--s3]
+
+   --clip will get the prompt from your clipboard's contents, in addition to <prompt> if you supply one
+   --s3 will upload the result to your AI_GETTER_S3_BUCKET
+   set env var AI_GETTER_ALWAYS_SAVE_TO_S3=1 to save to s3 by default
+```
+
 # Environment Variables
 
 - `OPENAI_ORG`
 - `OPENAI_TOKEN`
 - `AI_GETTER_SAVE_PATH`
 - `AI_GETTER_S3_BUCKET`
+- `AI_GETTER_ALWAYS_SAVE_TO_S3` (0 or 1)
 
 # Credentials