From d931b310f0f870b245dfcab0659b16b2427644d4 Mon Sep 17 00:00:00 2001 From: Meet Patel <113581962+meetpateltech@users.noreply.github.com> Date: Thu, 4 Jul 2024 18:20:05 +0530 Subject: [PATCH] improve readme - added badges of github stars , github forks, contributors - added Key Features section - added star history graph and contributors image --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 47 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1fad091b..af7162ca 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,21 @@ Interested in helping build the best second brain for everyone? Join the discord https://discord.gg/2X2XsKz5AU. Contributions welcome. +
+ + GitHub stars + + + GitHub forks + + + GitHub contributors + + + Chrome Web Store + +
+ ## 👀 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) @@ -16,6 +31,20 @@ But we never look back to it - to us, it's like throwing information in the void Supermemory fixes this. +## Key Features + +- 💡 **Ideation**: Capture and save ideas effortlessly. +- 🔖 **Bookmarks**: Import, organize, and resurface bookmarks when needed. +- 📇 **Contacts**: Store and manage information about people you know. +- 🐦 **Twitter Bookmarks**: Import and utilize your saved tweets. +- 🔍 **Powerful Search**: Quickly find any saved information. +- 💬 **Chat with Collections**: Interact with specific knowledge bases. +- 🖼️ **Knowledge Canvas**: Organize information visually in a 2D canvas. +- ✍️ **Writing Assistant**: Use a markdown editor with AI assistance for content creation. +- 🔒 **Privacy Focused**: Ensures data security and privacy. +- 🏠 **Self Hostable**: Open source and easy to deploy locally. +- 🔗 **Integrations**: Compatible with Telegram, Twitter, and more to come. + ## How do I use this? Just go to [supermemory.ai](https://supermemory.ai) and sign in with your google account. @@ -28,6 +57,12 @@ To use the chrome extension, ## 👨‍💻 The Stack +
+SuperMemory +
+ +#### Architecture: + ![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): @@ -55,30 +90,34 @@ Built with: 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) +![Import bookmarks](https://i.dhr.wtf/r/Clipboard_Apr_14,_2024_at_3.56 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 +- [Vite](https://vitejs.dev/) - [TailwindCSS](https://tailwindcss.com) - [shadcn-ui](https://ui.shadcn.com) -- React +- [React](https://react.dev/) #### `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 Workers](https://workers.cloudflare.com/) - [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) +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=Dhravya/supermemory&type=Date)](https://star-history.com/#Dhravya/supermemory&Date) + ## Contribute or self host Supermemory is design to be set up easily locally and super duper easy to set up 💫 @@ -88,3 +127,7 @@ 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. + + + + \ No newline at end of file