aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMahesh Sanikommmu <[email protected]>2025-08-16 20:15:39 -0700
committerMahesh Sanikommmu <[email protected]>2025-08-16 20:15:39 -0700
commitfddc21aab2f9f59623d76802d0ab2b17cbe7fa5b (patch)
treeaf2d510bf4c1913d9f7c5fd3348b9697e7928af6 /README.md
parentMerge pull request #366 from supermemoryai/mahesh/supermemory-new (diff)
downloadsupermemory-fddc21aab2f9f59623d76802d0ab2b17cbe7fa5b.tar.xz
supermemory-fddc21aab2f9f59623d76802d0ab2b17cbe7fa5b.zip
added usage notes
Diffstat (limited to 'README.md')
-rw-r--r--README.md114
1 files changed, 45 insertions, 69 deletions
diff --git a/README.md b/README.md
index afd2af2a..28179e96 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-<div align="center" style="padding-bottom:10px;padding-top:10px">
+<div align="center" style="padding-bottom:20px;padding-top:20px">
<img src="logo.svg" alt="supermemory Logo" width="400" />
</div>
@@ -6,94 +6,70 @@
<img src="apps/web/public/landing-page.jpeg" alt="supermemory" width="100%" />
</div>
-## ✨ Features
+## Features
### Core Functionality
-- **Add Memories from Any Content**: Easily add memories from URLs, PDFs, and plain textβ€”just paste, upload, or link.
-- **Chat with Your Memories**: Converse with your stored content using natural language chat.
-- **Supermemory MCP Integration**: Seamlessly connect with all major AI tools (Claude, Cursor, etc.) via Supermemory MCP.
-- **Graph View for All Memories**: Visualize and explore your memories and their connections in an interactive graph mode.
-
-## πŸ—οΈ Architecture
-This is a **Turborepo monorepo**
+- **[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.
-### Technology Stack
-- **Frontend**: Next.js 15 with React 19
-- **Backend**: Hono API framework on Cloudflare Workers
-- **Database**: PostgreSQL with Drizzle ORM
-- **Authentication**: Better Auth with organization support
-- **Package Manager**: Bun
-- **Monorepo**: Turbo for build optimization
-- **Styling**: Tailwind CSS with Radix UI components
-- **Monitoring**: Sentry for error tracking and performance monitoring
+## How do i use this?
-### Project Structure
-```
-β”œβ”€β”€ apps/
-β”‚ └── web/ # Next.js web application
-β”œβ”€β”€ packages/ # Shared packages and utilities
-β”œβ”€β”€ CLAUDE.md # Development guidelines for AI assistants
-β”œβ”€β”€ turbo.json # Turborepo configuration
-└── package.json # Root package configuration
-```
+Go to [app.supermemory.ai](https://app.supermemory.ai) and sign into with your account
-## πŸš€ Getting Started
+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>
-### Prerequisites
-- **Bun** package manager
+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>
-### Installation
+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>
-1. **Clone the repository**
- ```bash
- git clone https://github.com/supermemoryai/supermemory-app.git
- cd supermemory
- ```
+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>
-2. **Install dependencies**
- ```bash
- bun install
- ```
+## Support
-3. **Environment Setup**
-
- Create environment files for each app:
- ```bash
- # Copy environment templates
- cp apps/web/.env.example apps/web/.env.local
- ```
+Have questions or feedback? We're here to help:
-### Development
+- Documentation: [docs.supermemory.ai](https://docs.supermemory.ai)
-#### Start all applications in development mode:
-```bash
-bun run dev
-```
+## Contributing
-This will start:
-- Web app at `http://localhost:3000`
-- API endpoints available through the web app
+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
-## πŸ§ͺ Development Workflow
+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`
-### Code Quality
-- **Linting & Formatting**: Uses Biome for consistent code style
-- **Type Safety**: Strict TypeScript configuration across all packages
+For detailed guidelines, development setup, coding standards, and the complete contribution workflow, please see our [**Contributing Guide**](CONTRIBUTE.md).
-## 🀝 Contributing
+### Ways to Contribute
-### Development Guidelines
-- Follow the code style enforced by Biome
-- Write tests for new features
-- Update documentation when adding new functionality
-- Ensure all checks pass before submitting PRs
+- πŸ› **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!
-## πŸ’¬ Support & Community
+## Updates & Roadmap
-- **Issues**: [GitHub Issues](https://github.com/supermemoryai/supermemory-app/issues)
-- **Email**: [[email protected]](mailto:[email protected])
-- **Twitter**: [@supermemoryai](https://x.com/supermemoryai)
+Stay up to date with the latest improvements:
+- [Changelog](https://docs.supermemory.ai/changelog/overview)
+- [X](https://x.com/supermemoryai)