added readme

1 files changed, 83 insertions, 0 deletions

diff --git a/README.md b/README.md
index 2e30ffbc..29096cb0 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,84 @@
 ![og image](https://supermemory.dhr.wtf/og-image.png)
+
+# SuperMemory
+
+## 👀 What is this?
+
+Build your own second brain with supermemory. It's a ChatGPT for your bookmarks. Import tweets or save websites and content using the [chrome extension](https://chromewebstore.google.com/detail/supermemory/afpgkkipfdpeaflnpoaffkcankadgjfc?hl=en-GB&authuser=0) (the extension on webstore is not updated, please use the one in the repo)
+
+Well, here's the thing - me and @yxshv save a _lot_ of content on the internet.
+
+Twitter bookmarks, websites, snippets, etc.
+
+But we never look back to it - to us, it's like throwing information in the void.
+
+Supermemory fixes this.
+
+## How do I use this?
+
+Just go to [supermemory.dhr.wtf](https://supermemory.dhr.wtf) and sign in with your google account.
+
+To use the chrome extension, please download it from the [releases page](https://github.com/dhravya/supermemory/releases) and load it in chrome.
+
+## 👨‍💻 The Stack
+
+![overview](https://i.dhr.wtf/r/Clipboard_Apr_14,_2024_at_4.52 PM.png)
+
+Supermemory has three main modules, managed by [turborepo](https://turbo.build):
+
+#### `apps/web`: The main web UI.
+
+The database, auth etc logic is here
+
+![App preview](https://i.dhr.wtf/r/Clipboard_Apr_14,_2024_at_4.10 PM.png)
+
+Built with:
+
+- Nextjs 14
+- [Next Auth](https://next-auth.js.org/)
+- [Drizzle ORM](https://drizzle.team/)
+- [Cloudflare D1 database](https://developers.cloudflare.com/d1/get-started/)
+- Cloudflare ratelimiter
+- [TailwindCSS](https://tailwindcss.com)
+- [shadcn-ui](https://ui.shadcn.com)
+- And some other amazing open source projects like [Novel](https://novel.sh) and [vaul](https://vaul.emilkowal.ski/)
+- Hosted on Cloudflare Pages
+
+#### `apps/extension`: Chrome extension
+
+The chrome extension is one of the most important part of the setup, but is not required.This is to easily add pages to your memory.
+
+![Chrome extension preview](https://i.dhr.wtf/r/Clipboard_Apr_14,_2024_at_3.54 PM.png)
+
+You can also use it to import all your twitter bookmarks!
+![Import bookmarks](https://i.dhr.wtf/r/Clipboard_Apr_14,_2024_at_3.56 PM.png)
+
+Built with:
+
+- [CRXJS](https://crxjs.dev/vite-plugin/getting-started/react/create-project)
+- Vite
+- [TailwindCSS](https://tailwindcss.com)
+- [shadcn-ui](https://ui.shadcn.com)
+- React
+
+#### `apps/cf-ai-backend`: This module handles the vector store and AI response generation
+
+This is where the magic happens!
+Built with:
+
+- Cloudflare Workers
+- [Cloudflare AI](https://ai.cloudflare.com)
+- [Cloudflare Vectorize](https://developers.cloudflare.com/vectorize/)
+- [Cloudflare Queues](https://developers.cloudflare.com/queues/)
+- [Cloudflare Browser Rendering](https://developers.cloudflare.com/browser-rendering/)
+- [Cloudflare KV](https://developers.cloudflare.com/kv)
+
+## Contribute or self host
+
+Supermemory is design to be set up easily locally and super duper easy to set up 💫
+
+Please see the [SETUP-GUIDE.md](SETUP-GUIDE.md) for setup instructions.
+
+### Contributing
+
+Contributions are very welcome! A contribution can be as small as a ⭐ or even finding and creating issues.