update readme

Author: cak

README.md

@@ -1,31 +1,53 @@
-# hackertracker-export
+# HackerTracker Export
 
-Export HackerTracker events to JSON
+A tool to export HackerTracker events to JSON format.
 
-## Export Static HackerTracker Data
+## Table of Contents
 
-### Install Dependancies
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Export Static Data](#export-static-data)
+  - [Tailwind Safelisting Colors](#tailwind-safelisting-colors)
+- [References](#references)
+
+## Introduction
+
+HackerTracker Export is a utility designed to fetch and export the most recently updated HackerTracker events from Firebase into static JSON files.
+
+## Installation
+
+### Install Dependencies
+
+To get started, install the required npm packages:
 
 ```bash
-    npm install
+npm install
 ```
 
+## Usage
+
 ### Export Static Data
 
+To export the static data, run the following command:
+
 ```bash
-    npm run export
+npm run export
 ```
 
-_Fetches the 10 recently updated conferences from Firebase and exports static json files to a generated `out` directory_
-
-### Firebase API key
+This command will fetch the 25 most recently updated conferences from Firebase and export them as static JSON files into a newly generated `out` directory.
 
-Script requires the Firebase API key to be set as the `FIREBASE_API_KEY` environment variable. This stops [@Advice-Dog](https://github.com/Advice-Dog) from getting alerted every time I leak the key, but you are all hackers and undoubtedly you’ll find it anyway.
+### Tailwind Safelisting Colors
 
-### Tailwind Safelisting colors
+To safelist colors for Tailwind CSS, use the following command:
 
 ```sh
 jq '.[].type.color' ./events.json | sort -u | tr '\n' ',' | sed 's/.$//'
 ```
 
-[Tailwind Docs](https://tailwindcss.com/docs/content-configuration#safelisting-classes)
+For more information on safelisting classes in Tailwind CSS, refer to the [Tailwind CSS Documentation](https://tailwindcss.com/docs/content-configuration#safelisting-classes).
+
+## References
+
+- [HackerTracker](https://hackertracker.app/)
+- [Tailwind CSS Documentation](https://tailwindcss.com/docs/)