aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a8c8176adf5e23f44e809f4c4f66a260058d50b9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<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://supermemory.link/discord" 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>
<p style="font-size: 0.9em; color: #666;">
    <strong>Want to self-host?</strong> See our <a href="https://supermemory.ai/docs/deployment/self-hosting#self-hosting">Self-Hosting Guide</a> for enterprise deployment options.
</p>
<br/>

<div align="center" style="padding-bottom:10px;padding-top:10px">
  <img src="apps/web/public/landing-page.jpeg" alt="supermemory" width="100%" />
</div>

## Features

### Core Functionality

- **[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?

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">
  <img src="apps/web/public/add-memory.png" alt="supermemory" width="100%" />
</div>

2. You can also Connect to your favourite services (Notion, Google Drive, OneDrive)
<div align="center" style="padding-bottom:10px;padding-top:10px">
  <img src="apps/web/public/add-connections.png" alt="supermemory" width="100%" />
</div>

3. <a id="chat-memories"></a>Once Memories are added, you can chat with Supermemory by clicking on "Open Chat" and retrieve info from your saved memories
<div align="center" style="padding-bottom:10px;padding-top:10px">
  <img src="apps/web/public/chat.png" alt="supermemory" width="100%" />
</div>

4. <a id="mcp-integration"></a>Add MCP to your AI Tools (by clicking on "Connect to your AI" and select the AI tool you are trying to integrate)
<div align="center" style="padding-bottom:10px;padding-top:10px">
  <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:

- Email: [[email protected]](mailto:[email protected])
- 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.

For detailed guidelines, development setup, coding standards, and the complete contribution workflow, please see our [**Contributing Guide**](CONTRIBUTING.md).

### Ways to Contribute

- 🐛 **Bug fixes** - Help us squash those pesky issues
- **New features** - Add functionality that users will love
- 🎨 **UI/UX improvements** - Make the interface more intuitive
- **Performance optimizations** - Help us make supermemory faster

Check out our [Issues](https://github.com/supermemoryai/supermemory/issues) page for `good first issue` and `help wanted` labels to get started!

## Updates & Roadmap

Stay up to date with the latest improvements:

- [Changelog](https://docs.supermemory.ai/changelog/overview)
- [X](https://x.com/supermemoryai).