From 42e05e51f3ef5af8fd2df8cbdffa000240e5d2a9 Mon Sep 17 00:00:00 2001 From: Stephen DeLorme Date: Mon, 27 Nov 2023 19:03:29 -0500 Subject: [PATCH] updated readme for running summarizer locally --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a8102c..e198c49 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ This is a project to improve the UX of BitDevs websites and add AI generated sum ## AI Scraper and Summarizer +The intended usage is that you use the AI scraper and sumamrizer as a GitHub action, which will be triggered anytime changes are pushed to the `main` or `master` branch. + [How to setup repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) - Add repository secret `OPENAI_API_KEY` -> your Open AI API Key @@ -23,10 +25,10 @@ cd ai # Make a .env file inside the ai directory and add your OPENAI_API_KEY yarn install - -yarn start ``` +From there, your `/ai` directory has been configured. You should be able to return to the root website directory and then run `yarn summarize` to invoke the summarizer. + - It will pick markdown files inside `content/events` directory starting with a date in `yyyy-mm-dd`. - Only the most recent file sorted by date will be summarized. - Once the Github action finishes the building the summary, it will submit a PR to the repo. If the PR is merged, the repo builds and deploys to production and summaries are visible on the website.