update readme with instructions

README.md

@@ -1,5 +1,5 @@
 ---
-title: Tts Openai
+title: TTS
 emoji: 🔥
 colorFrom: green
 colorTo: red
@@ -13,5 +13,47 @@ hf_oauth: true
 # optional, default duration is 8 hours/480 minutes. Max duration is 30 days/43200 minutes.
 hf_oauth_expiration_minutes: 480
 ---
+# Getting Started
+> This spaces allows you to create speech audio from text. It currently works with OpenAI and Cartesia AI.
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+## Running Locally
+```bash
+git clone https://huggingface.co/spaces/matdmiller/tts-openai
+cd tts-openai
+pip install -r requirements.txt
+```
+Next create a file `tts_openai_secrets.py` to hold the secrets or set them up as environment variables yourself. 
+```python
+import os
+os.environ['OPENAI_API_KEY'] = 'sk-xxx'
+os.environ["CARTESIA_API_KEY"]= 'xxx'
+os.environ["ALLOWED_OAUTH_PROFILE_USERNAMES"]= '<your huggingface username>' #comma delimited
+os.environ["REQUIRE_AUTH"]= 'false'
+```
+This file is included in the `.gitignore` so it will not be included when you publish to your repo. This is very important because the 🤗 Spaces repos are public by default and you don't want to leak your API keys.
+
+Finally to run locally simply run:
+```bash
+python app.py
+```
+
+## Cloning to run in your own 🤗 Space.
+
+Click the `...` in the top right hand corder of my Space and click `Duplicate Space`.
+
+![A photo showing how to duplicate a Hugging Face Space.](./hf_duplicate_space.png "Duplicate Space")
+
+This will bring up a form that you need to fill out with the appropriate keys and settings.
+
+![A photo showing the form for duplicating a Hugging Face Space.](./hf_duplicate_space_form.png "Duplicate Space Form")
+
+- Owner: Your HF Username
+- Visibility: Public (Or Private if you know what you're doing). By default this app is secured with 🤗 OAuth and only allows usernames you specify in the `ALLOWED_OAUTH_PROFILE_USERNAMES` property.
+- Space Hardware: Free CPU Basic is plenty of horsepower for this app becuase all of the TTS work is happening behind the API.
+- `OPENAI_API_KEY`: Input your own OpenAI API key which you can get by signing up for an account on [https://platform.openai.com](https://platform.openai.com). This is completely separate from ChatGPT.
+- `CARTESIA_API_KEY`: Input your own Cartesia AI API key which you can obtain from [https://play.cartesia.ai/subscription](https://play.cartesia.ai/subscription)
+- `ALLOWED_OAUTH_PROFILE_USERNAMES`: Add a comma separated list of Hugging Face usernames that are allowed to use the space. Only usernames listed here will be allowed generate speech audio, though anyone can view the site. Ex: `santa1225,clem2024`. If you have a single username, don't add a comma.
+
+Click `Duplicate Space`.  Your new space should be created within a couple of minutes.
+
+Additional HF Spaced Config Info: https://huggingface.co/docs/hub/spaces-config-reference

app.ipynb

@@ -979,7 +979,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 34,
+   "execution_count": 35,
    "id": "0420310d-930b-4904-8bd4-3458ad8bdbd3",
    "metadata": {},
    "outputs": [],