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 1/2] 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.
+
+
## 👀 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
+
+

+
+
+#### Architecture:
+

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.

+
You can also use it to import all your twitter bookmarks!
-
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
+
+[](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
From 536f841126c55662756f01ecf8325dc7fda54c1f Mon Sep 17 00:00:00 2001
From: Meet Patel <113581962+meetpateltech@users.noreply.github.com>
Date: Fri, 5 Jul 2024 08:33:06 +0530
Subject: [PATCH 2/2] fix merge conflicts
---
README.md | 26 ++++++++++++++++++--------
1 file changed, 18 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index af7162ca..5958bbf2 100644
--- a/README.md
+++ b/README.md
@@ -51,9 +51,21 @@ Just go to [supermemory.ai](https://supermemory.ai) and sign in with your google
To use the chrome extension,
-1. Get the chrome ext (click on the button)
-2. Click on the "Extension Auth" button so the extension knows who you are :)
- 
+> [!WARNING]
+> You need to be signed in before installing the supermemory extension, or you may experience problems
+
+1. Download from [Chrome Web Store](https://chromewebstore.google.com/detail/supermemory/afpgkkipfdpeaflnpoaffkcankadgjfc?authuser=0&hl=en-GB)
+2. Now you can see on any page on bottom right (just click on it to save)
+
+
+### Import Twitter Bookmarks
+1. Make sure you signed into supermemory and installed chrome extension
+2. Open Twitter/X, you will see the save icon as follows
+
+
+4. Click on save button and give it 10 - 20 secs, where supermemory extension will sync all your twitter bookmarks to supermemory.ai
+5. Volia! Now your second brain has all your twitter bookmarks.
+
## 👨💻 The Stack
@@ -71,7 +83,8 @@ Supermemory has three main modules, managed by [turborepo](https://turbo.build):
The database, auth etc logic is here
-
+
+
Built with:
@@ -89,10 +102,7 @@ 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.
-
-
-
-You can also use it to import all your twitter bookmarks!
+
Built with: