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 [--clip] --num-images [--save-path ] [--s3] + aig text [--clip] [--save-path ] [--s3] + + --clip will get the prompt from your clipboard's contents, in addition to 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