Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tomhicks committed Oct 31, 2024
1 parent c7ea695 commit 31afb62
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ LINEAR_API_KEY=
ANTHROPIC_API_KEY=

# Google Calendar
# CURRENTLY UNUSED
# Path to your Google Cloud service account credentials JSON file
# Steps to obtain:
# 1. Create a Google Cloud Project: https://console.cloud.google.com/
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## eod-bot

Uses your git and linear contributions to generate a daily summary of your work.

You'll probably need to hack a few magic strings that I use to split my PRs up and stuff like
that but the general idea should be usable by anyone who has to write daily summaries.

## Setup

1. `cp .env.example .env`
2. Fill in the `.env` file with your details
3. `npm install`
4. `npm run gen-today` to generate today's summary or `npm run gen-yesterday` for yesterday's

0 comments on commit 31afb62

Please sign in to comment.