From 0fed404b2a180493f773c0cd014a7688a59fabbd Mon Sep 17 00:00:00 2001 From: jmbwell Date: Tue, 29 Aug 2023 20:07:33 +0000 Subject: [PATCH] update readme --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0f9e00..8eef2b3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -Splits a string on the comma and the word 'or', then returns a randomly selected fragment +# Chat +A Limnoria plugin that brings ChatGPT into your IRC channel + +## Installation + +1. Install the plugin +2. Put your API key in config.ini like so: + +``` +[Chat] +api_key = YOUR_API_KEY +``` + +3. Load the plugin: + +``` +load Chat +``` + +## Usage + +Example: +``` +> chat Hello! +< Hello there! How can I assist you today? +```