aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMaheshtheDev <[email protected]>2025-11-03 00:39:55 +0000
committerMaheshtheDev <[email protected]>2025-11-03 00:39:55 +0000
commita2071d0deb323752b68a0fa8df253ad6342d89e5 (patch)
tree5df099dba622f62c928d3237573cb956e05aedd6 /README.md
parentchore: mcp connection trouble nav to manual mcp (#552) (diff)
downloadsupermemory-a2071d0deb323752b68a0fa8df253ad6342d89e5.tar.xz
supermemory-a2071d0deb323752b68a0fa8df253ad6342d89e5.zip
chore: update readme with recent updates and latest demo (#547)10-31-chore_update_readme_with_recent_updates_and_latest_demo
This PR updates the README with several improvements: - Added a light/dark mode compatible logo using the `<picture>` element - Added a tagline: "Your AI second brain for saving and organizing everything that matters" - Added badges for Web App, Chrome Extension, and Raycast Extension - Added a developer resources section with links to the Developer Console and Documentation - Added detailed sections for the Browser Extension and Raycast Extension features - Fixed minor typos and grammar issues - Updated all screenshots with newer versions - Added a new logo-light-fullmark.svg file for light mode display - Removed the "Quick Start for Contributors" section as it's covered in the [CONTRIBUTING.md](http://CONTRIBUTING.md) ![image.png](https://app.graphite.dev/user-attachments/assets/ba470a79-c316-4034-9237-715e754b4471.png)
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 39 insertions, 12 deletions
diff --git a/README.md b/README.md
index a103dc1c..a69b1f96 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,33 @@
-<div align="center" style="padding-bottom:20px;padding-top:20px">
- <img src="apps/web/public/logo-fullmark.svg" alt="supermemory Logo" width="400" />
-</div>
+<p align="center" style="padding-bottom:20px;padding-top:20px">
+ <picture>
+ <source srcset="apps/web/public/logo-fullmark.svg" media="(prefers-color-scheme: dark)">
+ <source srcset="apps/web/public/logo-light-fullmark.svg" media="(prefers-color-scheme: light)">
+ <img src="apps/web/public/logo-fullmark.svg" alt="supermemory Logo" width="400" />
+ </picture>
+ <br/><br/>
+ <em>Your AI second brain for saving and organizing everything that matters.</em>
+ <br/><br/>
+ <a href="https://app.supermemory.ai" style="text-decoration: none;">
+ <img src="https://img.shields.io/badge/Web-App-000000?style=for-the-badge" alt="Web App" />
+ </a>
+ &nbsp;
+ <a href="https://chromewebstore.google.com/detail/supermemory/afpgkkipfdpeaflnpoaffkcankadgjfc" style="text-decoration: none;">
+ <img src="https://img.shields.io/badge/Chrome-Extension-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Chrome Extension" />
+ </a>
+ &nbsp;
+ <a href="https://www.raycast.com/supermemory/supermemory" style="text-decoration: none;">
+ <img src="https://img.shields.io/badge/Raycast-Extension-FF6363?style=for-the-badge&logo=raycast&logoColor=white" alt="Raycast Extension" />
+ </a>
+ &nbsp;
+ <a href="https://discord.gg/HXvsGK2f" style="text-decoration: none;">
+ <img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord" />
+ </a>
+</p>
+
+<p style="font-size: 0.9em; color: #666;">
+ <strong>Building with Supermemory?</strong> Check out the <a href="https://console.supermemory.ai?utm_source=github&utm_medium=readme&utm_campaign=consumer_app">Developer Console</a> and <a href="https://docs.supermemory.ai?utm_source=github&utm_medium=readme&utm_campaign=consumer_app">Documentation</a> for API access.
+</p>
+<br/>
<div align="center" style="padding-bottom:10px;padding-top:10px">
<img src="apps/web/public/landing-page.jpeg" alt="supermemory" width="100%" />
@@ -13,10 +40,12 @@
- **[Add Memories from Any Content](#add-memory)**: Easily add memories from URLs, PDFs, and plain text—just paste, upload, or link.
- **[Chat with Your Memories](#chat-memories)**: Converse with your stored content using natural language chat.
- **[Supermemory MCP Integration](#mcp-integration)**: Seamlessly connect with all major AI tools (Claude, Cursor, etc.) via Supermemory MCP.
+- **[Browser Extension](#browser-extension)**: Save memories directly from your browser with integrations for ChatGPT, Claude, and Twitter/X.
+- **[Raycast Extension](#raycast-extension)**: Add and search memories directly from Raycast with keyboard shortcuts.
-## How do i use this?
+## How do I use this?
-Go to [app.supermemory.ai](https://app.supermemory.ai) and sign into with your account
+Go to [app.supermemory.ai](https://app.supermemory.ai) and sign in with your account
1. <a id="add-memory"></a>Start Adding Memory with your choice of format (Note, Link, File)
<div align="center" style="padding-bottom:10px;padding-top:10px">
@@ -38,24 +67,22 @@ Go to [app.supermemory.ai](https://app.supermemory.ai) and sign into with your a
<img src="apps/web/public/mcp.png" alt="supermemory" width="100%" />
</div>
+5. <a id="browser-extension"></a>**Browser Extension**: Install the [Chrome/Edge extension](https://chromewebstore.google.com/detail/supermemory/afpgkkipfdpeaflnpoaffkcankadgjfc) to save memories directly from any webpage, integrate with ChatGPT and Claude conversations, and import from Twitter/X. Right-click on any content or use the extension popup to save memories instantly.
+
+6. <a id="raycast-extension"></a>**Raycast Extension**: Install the [Raycast extension](https://www.raycast.com/supermemory/supermemory) to add and search memories directly from Raycast. Use the "Add Memory" command to quickly save content, or "Search Memories" to find and retrieve your saved information with keyboard shortcuts.
+
## Support
Have questions or feedback? We're here to help:
+- Discord: [Join our Discord server](https://discord.gg/HXvsGK2f)
- Documentation: [docs.supermemory.ai](https://docs.supermemory.ai)
## Contributing
We welcome contributions from developers of all skill levels! Whether you're fixing bugs, adding features, or improving documentation, your help makes supermemory better for everyone.
-### Quick Start for Contributors
-
-1. **Fork and clone** the repository
-2. **Install dependencies** with `bun install`
-3. **Set up your environment** by copying `.env.example` to `.env.local`
-4. **Start developing** with `bun run dev`
-
For detailed guidelines, development setup, coding standards, and the complete contribution workflow, please see our [**Contributing Guide**](CONTRIBUTING.md).
### Ways to Contribute