Skip to content

Commit

Permalink
Add readme details closing #8; add contribs
Browse files Browse the repository at this point in the history
  • Loading branch information
CarlQLange committed Mar 23, 2023
1 parent 1a1d0cc commit a125459
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

0 comments on commit a125459

Please sign in to comment.