Added README

README.md

@@ -1,34 +1,43 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+<a href="https://chathn.vercel.app">
+  <img alt="Chat with Hacker News using natural language." src="/app/opengraph-image.png">
+  <h1 align="center">ChatHN</h1>
+</a>
 
-## Getting Started
+<p align="center">
+  Chat with Hacker News using natural language. Built with OpenAI Functions and Vercel AI SDK. 
+</p>
 
-First, run the development server:
+## Introduction
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
+ChatHN is an an open-source AI chatbot that uses [OpenAI Functions](https://platform.openai.com/docs/guides/gpt/function-calling) and the [Vercel AI SDK](https://sdk.vercel.ai/docs) to interact with the [Hacker News API](https://github.com/HackerNews/API) with natural language.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Setting Up Locally
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+To set up Novel locally, you'll need to clone the repository and set up the following environment variables:
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+- `OPENAI_API_KEY` – your OpenAI API key (you can get one [here](https://platform.openai.com/account/api-keys))
 
-## Learn More
+## Tech Stack
 
-To learn more about Next.js, take a look at the following resources:
+Novel is built on the following stack:
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- [Next.js](https://nextjs.org/) – framework
+- [OpenAI Functions](https://platform.openai.com/docs/guides/gpt/function-calling) - AI completions
+- [Vercel AI SDK](https://sdk.vercel.ai/docs) – AI streaming library
+- [Vercel](https://vercel.com) – deployments
+- [TailwindCSS](https://tailwindcss.com/) – styles
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## Contributing
 
-## Deploy on Vercel
+Here's how you can contribute:
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+- [Open an issue](https://github.com/steven-tey/novel/issues) if you believe you've encountered a bug.
+- Make a [pull request](https://github.com/steven-tey/novel/pull) to add new features/make quality-of-life improvements/fix bugs.
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+## Author
+
+- Steven Tey ([@steventey](https://twitter.com/steventey))
+
+## License
+
+Licensed under the [MIT license](https://github.com/steven-tey/novel/blob/main/LICENSE.md).

app/page.tsx

@@ -178,7 +178,16 @@ export default function Chat() {
           >
             Vercel AI SDK
           </a>
-          . View the repo or deploy your own.
+          . View the{" "}
+          <a
+            href="https://github.com/steven-tey/chathn"
+            target="_blank"
+            rel="noopener noreferrer"
+            className="transition-colors hover:text-black"
+          >
+            repo
+          </a>{" "}
+          or deploy your own.
         </p>
       </div>
     </main>