Create README.md

stym06 · Jul 1, 2024 · 9c61038 · 9c61038
1 parent 08abb93
commit 9c61038
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# Random Hacker News Story Fetcher
+
+This Go script fetches the top stories from Hacker News, selects a random story, and opens Chrome with the url
+
+## Prerequisites
+
+- Go 1.16 or later
+
+## Installation
+
+1. Clone the repository: `git clone github.com/stym06/hackernews-bot.git && cd hackernews-bot`
+2. Run `make build`
+3. Run `source ~/.zshrc`
+
+## Usage
+When you run `hn` command now, it will open up Chrome with a random story from HackerNews
+
+```
+$> hn
+  Tripping on Xenon Gas (2023)
+  https://tripsitter.substack.com/p/xenon
+```
+