mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-09-05 08:06:19 +00:00
75 lines
3.2 KiB
Markdown
75 lines
3.2 KiB
Markdown
<div align="center" style="padding-bottom:20px;padding-top:20px">
|
|
<img src="logo.svg" alt="supermemory Logo" width="400" />
|
|
</div>
|
|
|
|
<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.
|
|
|
|
## How do i use this?
|
|
|
|
Go to [app.supermemory.ai](https://app.supermemory.ai) and sign into with your account
|
|
|
|
1. <a id="add-memory"></a>Start Adding Memory with your choose 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>
|
|
|
|
## Support
|
|
|
|
Have questions or feedback? We're here to help:
|
|
|
|
- Email: [dhravya@supermemory.com](mailto:dhravya@supermemory.com)
|
|
- 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**](CONTRIBUTE.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).
|