From 0dad87716698a0c1f6e0e3d17999ea9aba8b407c Mon Sep 17 00:00:00 2001 From: Manik Aggarwal Date: Thu, 31 Jul 2025 10:20:19 +0530 Subject: [PATCH] Update README.md - added new self-hosting instruction in the readme - added new product images - Linked readme to the latest docs --- README.md | 113 +++++++----------------------------------------------- 1 file changed, 14 insertions(+), 99 deletions(-) diff --git a/README.md b/README.md index 3c77a7c..e66fdff 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ C.O.R.E is a portable memory graph built from your llm interactions and personal [Check C.O.R.E Demo](https://youtu.be/iANZ32dnK60) -Core dashboard +core-memory-graph ## šŸ§© Key Features @@ -71,115 +71,30 @@ C.O.R.E is a portable memory graph built from your llm interactions and personal ## ā˜ļø C.O.R.E Cloud Setup -1. Sign up to [Core Cloud](https://core.heysol.ai) and start building your memory graph. -2. Add your text that you want to save in memory. Once clicking on `+ Add` button your memory graph will be generated. -3. [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor) +1. Visit [core.heysol.ai](https://core.heysol.ai) +2. Sign up with your email +3. Tell CORE about yourself: ā€œIā€™m a software engineer working on a React project called TaskMaster. I prefer TypeScript and use Tailwind for styling.ā€ + add-memory +4. [Connect Core MCP with Claude](https://docs.heysol.ai/providers/claude) +5. [Connect Core MCP with Cursor](https://docs.heysol.ai/providers/cursor) -## šŸ’» C.O.R.E Local Setup +## šŸ’» C.O.R.E Self Hosting -#### Prerequisites - -1. Docker -2. OpenAI API Key - - -> **Note:** We are actively working on improving support for Llama models. At the moment, C.O.R.E does not provide optimal results with Llama-based models, but we are making progress to ensure better compatibility and output in the near future. -> -#### Run C.O.R.E locally - -1. **Copy Environment Variables** - - Copy the example environment file to `.env`: - - ```bash - cp .env.example .env - ``` - -2. **Start the Application** - - Use Docker Compose to start all required services: - - ```bash - docker-compose up - ``` - -3. **Access the App** - - Once the containers are running, open your browser and go to [http://localhost:3000](http://localhost:3000). - -4. **Create Account with Magic Link** - - - To Create an account, click on `Continue with email` button - - Create account - - - Enter your email and click on `Send a Magic Link` button - - Enter email - - - `Copy the magic link from terminal logs` and open it in your browser - - Magic link - - -5. **Create Your Private Space & Add Data** - - - In the dashboard, go to the top right section -> Type a message, e.g., `I love playing badminton`, and click `+Add`. - - Your memory is queued for processing; you can monitor its status in the `Logs` section. - - Core memory logs - - - Once processing is complete, nodes will be added to your private knowledge graph and visible in the dashboard. - - You can later choose to connect this memory to other tools or keep it private. - -6. **Search Your Memory** - - - Use the dashboard's search feature to query your ingested data within your private space. - - -## Connecting CORE MCP with Cursor - -1. Open the CORE dashboard and navigate to the API section to generate a new API token. -2. In Cursor, go to: Settings ā†’ Tools & Integrations ā†’ New MCP Server. -3. Add the CORE MCP server using the configuration format below. Be sure to replace the API_TOKEN value with the token you generated in step 1. - - MCP configuration to add in Cursor - - ```json - { - "mcpServers": { - "memory": { - "command": "npx", - "args": ["-y", "@redplanethq/core-mcp"], - "env": { - "API_TOKEN": "YOUR_API_TOKEN_HERE", - "API_BASE_URL": "https://core.heysol.ai", - "SOURCE": "cursor" - } - } - } - } - ``` - -4. Go to Settings-> User rules -> New Rule -> and add the below rule to ensure all your chat interactions are being stored in CORE memory - -``` -After every interaction, update the memory with the user's query and the assistant's -response to core-memory mcp. sessionId should be the uuid of the conversation -``` +Check out our [docs](https://docs.heysol.ai/self-hosting/docker) for modular deployment ## Documentation Explore our documentation to get the most out of CORE -- [Basic Concepts](https://docs.heysol.ai/core/overview) -- [API Reference](https://docs.heysol.ai/core/local-setup) -- [Connect Core Memory MCP with Cursor](#connecting-core-mcp-with-cursor) +- [Basic Concepts](https://docs.heysol.ai/concepts/memory_graph) +- [Self Hosting](https://docs.heysol.ai/self-hosting/overview) +- [Connect Core MCP with Claude](https://docs.heysol.ai/providers/claude) +- [Connect Core MCP with Cursor](https://docs.heysol.ai/providers/cursor) ## šŸ§‘ā€šŸ’» Support Have questions or feedback? We're here to help: - Discord: [Join core-support channel](https://discord.gg/YGUZcvDjUa) -- Documentation: [docs.heysol.ai/core](https://docs.heysol.ai/core/overview) +- Documentation: [docs.heysol.ai](https://docs.heysol.ai) - Email: manik@poozle.dev ## Usage Guidelines