Merge pull request #8 from AutoLLM/fixes

specify that SendGrid must match FROM_EMAIL

README.md

@@ -1,5 +1,5 @@
-# Personalized-arXiv-digest
-This repo aims to provide a better daily digest for newly published arXiv papers based on your own research interests and descriptions.
+# ArxivDigest 
+This repo aims to provide a better daily digest for newly published arXiv papers based on your own research interests and descriptions via relevancy ratings from GPT.
 
 ## 📚 Contents
 
@@ -27,7 +27,8 @@ This repository offers a method to curate a daily digest, sorted by relevance, u
 
 ### Some examples:
 
-- Subject: Computer Science
+#### Digest Configuration:
+- Subject/Topic: Computer Science
 - Categories: Artificial Intelligence, Computation and Language 
 - Interest: 
   - Large language model pretraining and finetunings
@@ -35,12 +36,14 @@ This repository offers a method to curate a daily digest, sorted by relevance, u
   - Do not care about specific application, for example, information extraction, summarization, etc.
   - Not interested in paper focus on specific languages, e.g., Arabic, Chinese, etc.
 
+#### Result:
 ![example1](./readme_images/example_1.png)
 
-
-- Subject: Quantitative Finance
+#### Digest Configuration:
+- Subject/Topic: Quantitative Finance
 - Interest: "making lots of money"
 
+#### Result:
 ![example2](./readme_images/example_2.png)
 
 ## 💡 Usage
@@ -56,8 +59,8 @@ The recommended way to get started using this repository is to:
 5. Set the following secrets [(under settings, Secrets and variables, repository secrets)](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository):
    - `OPENAI_API_KEY`
    - `SENDGRID_API_KEY`
-   - `FROM_EMAIL` (only if you don't have it set in `config.yaml`)
-   - `TO_EMAIL` (only if you don't have it set in `config.yaml`)
+   - `FROM_EMAIL` This value must match the email you used to create the SendGrid Api Key. This is not needed if you have it set in `config.yaml`.
+   - `TO_EMAIL` Only if you don't have it set in `config.yaml`
 6. Manually trigger the action or wait until the scheduled action takes place.
 
 ![artifact](./readme_images/trigger.png)
@@ -96,11 +99,11 @@ If you do not wish to fork this repository, and would prefer to clone and run it
 2. Modify the configuration file `config.yaml`
 3. Create or fetch your api key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
 4. Create or fetch your api key for [SendGrid](https://app.SendGrid.com/settings/api_keys) (optional, if you want the script to email you)
-5. Set the following secrets [(under settings, Secrets and variables, repository secrets)](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository):
+5. Set the following secrets as environment variables: 
    - `OPENAI_API_KEY`
    - `SENDGRID_API_KEY` (only if using SendGrid)
-   - `FROM_EMAIL` (only if using SendGrid and if you don't have them set in `config.yaml`)
-   - `TO_EMAIL` (only if using SendGrid and if you don't have them set in `config.yaml`)
+   - `FROM_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`. Note that this value must match the email you used to create the SendGrid Api Key.)
+   - `TO_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`)
 6. Run `python action.py`.
 7. If you are not using SendGrid, the html of the digest will be written to `digest.html`. You can then use your favorite webbrowser to view it.
 
@@ -108,7 +111,7 @@ You may want to use something like crontab to schedule the digest.
 
 ### Running with a user interface
 
-Install the requirements in `src/requirements.txt` as well as `gradio`. Set the evironment variables `OPENAI_API_KEY`, `FROM_EMAIL` and `SENDGRID_API_KEY`
+Install the requirements in `src/requirements.txt` as well as `gradio`. Set the evironment variables `OPENAI_API_KEY`, `FROM_EMAIL` and `SENDGRID_API_KEY`. Ensure that `FROM_EMAIL` matches `SENDGRID_API_KEY`.
 
 Run `python src/app.py` and go to the local URL. From there you will be able to preview the papers from today, as well as the generated digests.