From d9f02cb50c80c48a2e32799d7036117998b0a1a4 Mon Sep 17 00:00:00 2001
From: Butterscotch! <bscotchvanilla@gmail.com>
Date: Tue, 30 Jan 2024 03:36:53 -0500
Subject: [PATCH] Update credit & add install instructions to README

---
 README.md | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 3ff6cdc..e6d1ae8 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,25 @@
 # ButterSTT
 
-A simple real-time speech to text application for the VRChat chatbox
+A simple real-time speech to text application for the VRChat chatbox.
 
-Using:
+## Installation
+- Download the zip and extract it into a folder.
+- Download a model file from https://abb128.github.io/april-asr/models.html.
+  - Recommended: [april-english-dev-01110_en.april](https://april.sapples.net/april-english-dev-01110_en.april)
+- Place the model file in the `Models` folder next to `ButterSTT.exe`.
+
+## Usage
+- Run `ButterSTT.exe`, it will connect to VRChat OSC at `127.0.0.1:9000` by default.
+- Optionally, configure the program by editing the values in `config.json`.
+
+## Credit
+
+### Using
 
 - <https://github.com/naudio/NAudio>
 - <https://github.com/abb128/april-asr>
-- <https://github.com/VRCWizard/CoreOSC-VRC-UTF8>
+- <https://github.com/LucHeart/CoreOSC-UTF8-ASYNC>
 
-Loosely based on:
+### Loosely based on
 
 - <https://github.com/VRCWizard/TTS-Voice-Wizard>