From a125459cf392fb38f4aa929b849be5dab9fd32c6 Mon Sep 17 00:00:00 2001 From: Carl Lange Date: Thu, 23 Mar 2023 09:17:04 +0000 Subject: [PATCH] Add readme details closing #8; add contribs --- readme.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index bbae871..6e9d327 100644 --- a/readme.md +++ b/readme.md @@ -43,6 +43,21 @@ ChatGPT-Arcana isn’t on melpa or elpa. You can use use-package to install from :init (setq chatgpt-arcana-api-key "your-api-key-here")) ``` +You may wish to use `.authinfo` or similar to hold your API key. You can do this by creating or adding to your `~/.authinfo` file like the following: + +``` +machine chat.openai.com login YOUR_CHATGPT_EMAIL_HERE password YOUR_API_KEY_HERE +``` + +and using the line + +```elisp +(setq chatgpt-arcana-api-key (auth-source-pick-first-password + :host "chat.openai.com")) +``` + +in your config. + My own config adds a few extra parts that don't need to be part of the package. ```elisp @@ -94,9 +109,14 @@ I have done exactly zero work in terms of compatibility. It works on my machine, ## Credits -This package was developed by Carl Lange with judicious help from ChatGPT. +This package was developed by Carl Lange with judicious help from ChatGPT. + +Other contributors and contributions: +- GitHub user [macownersclub](https://github.com/macownersclub) for [PR #6](https://github.com/CarlQLange/chatgpt-arcana.el/pull/6) +- GitHub user [vxe](https://github.com/vxe) for authinfo tip in [issue #8](https://github.com/CarlQLange/chatgpt-arcana.el/issues/8) ## License This package is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html). -*Important note*: code generated by ChatGPT probably has a massive license headache attached to it and may result in RMS eating your dog. + +*Important note*: code generated by ChatGPT probably has a **massive license headache** attached to it and may result in RMS eating your dog.