added readme

This commit is contained in:
Rudis Muiznieks 2023-09-25 17:06:28 -05:00
parent a3a9bbb511
commit cc4951f515
Signed by: rudism
GPG key ID: CABF2F86EF7884F9

13
README.md Normal file
View file

@ -0,0 +1,13 @@
# FreshRSS Kagi Summarizer
Adds a "Summarize" button to the top of all entries that will fetch the summary of the entry using the [Kagi Universal Summarizer](https://kagi.com/summarizer/index.html).
You will need a [Kagi](https://kagi.com) account so that you can configure the extension with your session link.
## Installation
1. Download the [latest release](https://code.sitosis.com/rudism/freshrss-kagi-summarizer/releases/latest).
2. Extract and upload it to the `extensions` folder of your FreshRSS installation.
3. Enable the extension in FreshRSS.
4. Go to your [Kagi Account Settings](https://kagi.com/settings?p=user_details) and copy your "Session Link."
5. Paste that link into the in the Kagi Summarizer extension settings in FreshRSS.