Skip to content

Commit 6f44f97

Browse files
committed
updated readme
1 parent bba5978 commit 6f44f97

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,26 @@ Almost anywhere in windows where you can enter text. Any text editor, search box
2525

2626
Download and extract the [latest release](https://github.com/ecornell/ai-tools-ahk/releases) .zip file. If you already have [AutoHotkey](https://www.autohotkey.com) installed then run `AI-Tools.ahk`, otherwise run the `.exe` version which lets you use the script without having AutoHotkey installed. The script doesn't install anything and it's also portable so it can be run from any location.
2727

28-
On first run, the script will create a `settings.ini` file in the same directory. This file contains the settings for the script. You can edit this file to change the hotkeys or to add your own prompts.
28+
On first run, the script will copy the included `setting.ini.default` file to a new `settings.ini` file in the same directory. This file contains the settings for the script. You can edit this file to change the hotkeys or to add your own prompts.
2929

3030
It will also prompt you to enter your OpenAI API key. You can get a API key from [OpenAI](https://platform.openai.com/).
3131

3232

3333
## Usage
3434

35-
`Ctrl+Shift+j` - Run the quick action 1 (Correct Spelling and Grammar) prompt on the selected text.
35+
`Ctrl+Shift+j` - Run the "Fix Spelling" prompt and replaces the current line or paragraph of text with the corrected version.
3636

37-
`Ctrl+Shift+k` - Run the quick action 2 (Continuation) prompt on the selected text.
37+
`Ctrl+Shift+k` - Run the "Continuation" prompt and append it to the text on the current line.
3838

3939
`Ctrl+Alt+Shift+k` - Open prompt menu to select the prompt to run on the selected text.
4040

4141
### How does it work?
4242

43-
## Supporting APIs
44-
OpenAI - /v1/chat/completions (Default)
45-
- /v1/completions
46-
- /v1/edits
47-
Azure - /openai/deployments/***/completions
48-
4943

5044

5145
## Options
5246

53-
*(Any time you make any changes to the `settings.ini` file you will need to select "Reload This Script" from the tray icon to update the script with the new settings)*
47+
`settings.ini` contains the settings for the script. You can edit this file to change the hotkeys or to add your own prompts.
5448

5549

5650
**Start with windows**
@@ -59,6 +53,18 @@ To have the script start when windows boots up, select "Start With Windows" from
5953
 
6054

6155

56+
## Supported APIs
57+
OpenAI
58+
59+
/v1/chat/completions (Default)
60+
/v1/completions
61+
/v1/edits
62+
63+
Azure
64+
65+
/openai/deployments/***/completions
66+
67+
6268
## Credits
6369

64-
Laszlo, Oldman and many others from the AHK community.
70+
TheArkive (JXON_ahk2) and the AHK community.

0 commit comments

Comments
 (0)