diff options
| author | MaheshtheDev <[email protected]> | 2025-11-03 00:39:55 +0000 |
|---|---|---|
| committer | MaheshtheDev <[email protected]> | 2025-11-03 00:39:55 +0000 |
| commit | a2071d0deb323752b68a0fa8df253ad6342d89e5 (patch) | |
| tree | 5df099dba622f62c928d3237573cb956e05aedd6 | |
| parent | chore: mcp connection trouble nav to manual mcp (#552) (diff) | |
| download | supermemory-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)

| -rw-r--r-- | README.md | 51 | ||||
| -rw-r--r-- | apps/web/public/add-connections.png | bin | 339198 -> 378476 bytes | |||
| -rw-r--r-- | apps/web/public/add-memory.png | bin | 371710 -> 337871 bytes | |||
| -rw-r--r-- | apps/web/public/chat.png | bin | 342407 -> 188671 bytes | |||
| -rw-r--r-- | apps/web/public/logo-light-fullmark.svg | 15 | ||||
| -rw-r--r-- | apps/web/public/mcp.png | bin | 421670 -> 470925 bytes |
6 files changed, 54 insertions, 12 deletions
@@ -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> + + <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> + + <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> + + <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: - 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. -### 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 diff --git a/apps/web/public/add-connections.png b/apps/web/public/add-connections.png Binary files differindex 1f49f4da..e2f8216a 100644 --- a/apps/web/public/add-connections.png +++ b/apps/web/public/add-connections.png diff --git a/apps/web/public/add-memory.png b/apps/web/public/add-memory.png Binary files differindex 248ea3e3..f2e60ae8 100644 --- a/apps/web/public/add-memory.png +++ b/apps/web/public/add-memory.png diff --git a/apps/web/public/chat.png b/apps/web/public/chat.png Binary files differindex 869c27ec..3c64140d 100644 --- a/apps/web/public/chat.png +++ b/apps/web/public/chat.png diff --git a/apps/web/public/logo-light-fullmark.svg b/apps/web/public/logo-light-fullmark.svg new file mode 100644 index 00000000..112cc0a0 --- /dev/null +++ b/apps/web/public/logo-light-fullmark.svg @@ -0,0 +1,15 @@ +<svg width="2135" height="256" viewBox="0 0 2135 256" fill="none" xmlns="http://www.w3.org/2000/svg"> +<path d="M313.728 100.982H197.297V0H159.68V109.567C159.68 121.205 164.284 132.381 172.466 140.615L267.535 236.283L294.134 209.517L223.917 138.858H313.75V101.004L313.728 100.982Z" fill="#1C2026"/> +<path d="M19.616 46.5043L89.8323 117.163H0V155.017H116.431V255.999H154.048V146.432C154.048 134.795 149.444 123.618 141.262 115.384L46.2144 19.7383L19.616 46.5043Z" fill="#1C2026"/> +<path d="M502.658 202.047C484.416 202.047 469.448 198.072 457.796 190.124C446.122 182.175 439.075 170.823 436.631 156.046L469.361 147.527C470.67 154.158 472.895 159.362 475.994 163.138C479.092 166.937 482.954 169.616 487.558 171.24C492.162 172.843 497.203 173.656 502.658 173.656C510.927 173.656 517.037 172.185 520.986 169.264C524.936 166.322 526.921 162.699 526.921 158.33C526.921 153.96 525.045 150.622 521.27 148.251C517.495 145.88 511.495 143.947 503.203 142.432L495.304 141.005C485.529 139.117 476.583 136.504 468.51 133.188C460.414 129.873 453.934 125.284 449.046 119.421C444.159 113.559 441.715 105.983 441.715 96.7172C441.715 82.7085 446.799 71.9713 456.945 64.4839C467.113 57.0184 480.445 53.2637 497.006 53.2637C512.608 53.2637 525.59 56.7768 535.933 63.7593C546.276 70.7637 553.04 79.9418 556.247 91.2938L523.234 101.504C521.728 94.3239 518.673 89.2078 514.069 86.1777C509.465 83.1476 503.77 81.6326 497.006 81.6326C490.242 81.6326 485.049 82.8182 481.492 85.1896C477.914 87.561 476.125 90.8327 476.125 94.9826C476.125 99.5278 478.001 102.887 481.776 105.061C485.529 107.235 490.613 108.904 497.006 110.023L504.905 111.451C515.444 113.339 524.979 115.842 533.533 118.982C542.086 122.1 548.85 126.557 553.847 132.332C558.822 138.107 561.331 145.924 561.331 155.761C561.331 170.516 556.007 181.934 545.381 189.97C534.755 198.028 520.506 202.047 502.636 202.047H502.658Z" fill="#1C2026"/> +<path d="M623.3 201.474C612.39 201.474 602.855 198.971 594.672 193.943C586.49 188.937 580.14 181.976 575.624 173.084C571.107 164.191 568.859 153.959 568.859 142.431V58.4004H604.404V139.599C604.404 150.204 606.979 158.153 612.172 163.444C617.343 168.736 624.718 171.393 634.319 171.393C645.229 171.393 653.695 167.748 659.717 160.458C665.739 153.168 668.751 143.002 668.751 129.937V58.4004H704.295V199.213H669.318V180.769H664.234C661.986 185.511 657.753 190.144 651.535 194.69C645.338 199.235 635.912 201.496 623.322 201.496L623.3 201.474Z" fill="#1C2026"/> +<path d="M729.672 255.992V58.3981H764.649V75.437H769.733C772.919 69.9477 777.916 65.0731 784.68 60.8134C791.444 56.5537 801.132 54.4238 813.744 54.4238C825.025 54.4238 835.476 57.2124 845.055 62.7896C854.656 68.3667 862.358 76.5568 868.184 87.3379C874.01 98.1189 876.934 111.184 876.934 126.51V131.055C876.934 146.381 874.01 159.446 868.184 170.227C862.358 181.008 854.634 189.198 845.055 194.775C835.454 200.352 825.025 203.141 813.744 203.141C805.278 203.141 798.186 202.153 792.448 200.155C786.709 198.179 782.105 195.61 778.614 192.492C775.123 189.374 772.352 186.212 770.3 182.984H765.216V255.948H729.672V255.992ZM803.03 171.961C814.137 171.961 823.301 168.404 830.545 161.312C837.789 154.22 841.411 143.856 841.411 130.221V127.388C841.411 113.753 837.746 103.389 830.414 96.2965C823.083 89.2043 813.962 85.6472 803.052 85.6472C792.142 85.6472 783.021 89.2043 775.69 96.2965C768.359 103.389 764.693 113.753 764.693 127.388V130.221C764.693 143.856 768.359 154.22 775.69 161.312C783.021 168.404 792.142 171.961 803.052 171.961H803.03Z" fill="#1C2026"/> +<path d="M959.326 203.185C945.405 203.185 933.143 200.199 922.516 194.248C911.89 188.276 903.62 179.866 897.685 168.975C891.772 158.084 888.805 145.261 888.805 130.506V127.103C888.805 112.347 891.707 99.5242 897.554 88.6334C903.38 77.7425 911.563 69.3329 922.102 63.3605C932.641 57.41 944.86 54.4238 958.781 54.4238C972.702 54.4238 984.463 57.4979 994.609 63.6459C1004.76 69.794 1012.68 78.3134 1018.31 89.2043C1023.96 100.095 1026.77 112.721 1026.77 127.103V139.311H924.916C925.287 148.972 928.866 156.811 935.63 162.871C942.394 168.931 950.686 171.961 960.461 171.961C970.236 171.961 977.764 169.788 982.455 165.44C987.147 161.093 990.725 156.262 993.169 150.97L1022.23 166.296C1019.59 171.215 1015.8 176.573 1010.8 182.347C1005.8 188.122 999.191 193.04 990.9 197.103C982.63 201.165 972.091 203.207 959.305 203.207L959.326 203.185ZM925.178 112.611H990.638C989.874 104.465 986.645 97.9433 980.906 93.0248C975.168 88.1064 967.683 85.6472 958.475 85.6472C949.267 85.6472 941.26 88.1064 935.63 93.0248C929.979 97.9433 926.509 104.487 925.2 112.611H925.178Z" fill="#1C2026"/> +<path d="M1044.25 199.211V58.399H1079.23V74.2961H1084.31C1086.38 68.6092 1089.81 64.4592 1094.61 61.8024C1099.41 59.1456 1104.99 57.8281 1111.39 57.8281H1128.32V89.6224H1110.82C1101.79 89.6224 1094.37 92.0377 1088.54 96.8683C1082.72 101.699 1079.79 109.12 1079.79 119.155V199.211H1044.25Z" fill="#1C2026"/> +<path d="M1141.85 199.213V58.4003H1176.82V73.7265H1181.91C1184.35 69.0057 1188.39 64.8777 1194.04 61.3865C1199.69 57.8953 1207.11 56.1387 1216.32 56.1387C1226.29 56.1387 1234.28 58.0709 1240.3 61.9574C1246.32 65.8438 1250.92 70.894 1254.13 77.1518H1259.22C1262.4 71.0916 1266.92 66.0853 1272.77 62.1111C1278.59 58.1368 1286.86 56.1606 1297.6 56.1606C1306.24 56.1606 1314.09 58.005 1321.16 61.6939C1328.21 65.3827 1333.86 70.9599 1338.1 78.4473C1342.33 85.9348 1344.44 95.3325 1344.44 106.706V199.257H1308.9V109.253C1308.9 101.503 1306.91 95.6838 1302.99 91.7974C1299.04 87.9109 1293.47 85.9787 1286.34 85.9787C1278.24 85.9787 1272 88.5916 1267.57 93.7955C1263.14 98.9994 1260.94 106.421 1260.94 116.082V199.279H1225.4V109.275C1225.4 101.525 1223.41 95.7058 1219.48 91.8194C1215.53 87.9329 1209.97 86.0007 1202.83 86.0007C1194.74 86.0007 1188.5 88.6136 1184.07 93.8175C1179.64 99.0214 1177.44 106.443 1177.44 116.104V199.301H1141.89L1141.85 199.213Z" fill="#1C2026"/> +<path d="M1432.45 203.185C1418.52 203.185 1406.26 200.199 1395.64 194.248C1385.01 188.276 1376.74 179.866 1370.8 168.975C1364.89 158.084 1361.92 145.261 1361.92 130.506V127.103C1361.92 112.347 1364.83 99.5242 1370.67 88.6334C1376.5 77.7425 1384.68 69.3329 1395.22 63.3605C1405.76 57.41 1417.98 54.4238 1431.9 54.4238C1445.82 54.4238 1457.58 57.4979 1467.73 63.6459C1477.87 69.794 1485.79 78.3134 1491.42 89.2043C1497.08 100.095 1499.89 112.721 1499.89 127.103V139.311H1398.04C1398.41 148.972 1401.99 156.811 1408.75 162.871C1415.51 168.931 1423.8 171.961 1433.58 171.961C1443.36 171.961 1450.88 169.788 1455.6 165.44C1460.29 161.093 1463.87 156.262 1466.31 150.97L1495.37 166.296C1492.73 171.215 1488.94 176.573 1483.94 182.347C1478.94 188.122 1472.33 193.04 1464.04 197.103C1455.77 201.165 1445.23 203.207 1432.45 203.207V203.185ZM1398.32 112.611H1463.78C1463.02 104.465 1459.79 97.9433 1454.05 93.0248C1448.31 88.1064 1440.82 85.6472 1431.62 85.6472C1422.41 85.6472 1414.4 88.1064 1408.77 93.0248C1403.12 97.9433 1399.65 104.487 1398.34 112.611H1398.32Z" fill="#1C2026"/> +<path d="M1517.37 199.213V58.4003H1552.34V73.7265H1557.43C1559.87 69.0057 1563.91 64.8777 1569.56 61.3865C1575.21 57.8953 1582.63 56.1387 1591.84 56.1387C1601.81 56.1387 1609.8 58.0709 1615.82 61.9574C1621.84 65.8438 1626.44 70.894 1629.65 77.1518H1634.74C1637.92 71.0916 1642.44 66.0853 1648.29 62.1111C1654.11 58.1368 1662.38 56.1606 1673.12 56.1606C1681.76 56.1606 1689.61 58.005 1696.68 61.6939C1703.73 65.3827 1709.38 70.9599 1713.61 78.4473C1717.85 85.9348 1719.96 95.3325 1719.96 106.706V199.257H1684.42V109.253C1684.42 101.503 1682.43 95.6838 1678.51 91.7974C1674.56 87.9109 1668.99 85.9787 1661.86 85.9787C1653.76 85.9787 1647.52 88.5916 1643.09 93.7955C1638.66 98.9994 1636.46 106.421 1636.46 116.082V199.279H1600.92V109.275C1600.92 101.525 1598.93 95.7058 1595 91.8194C1591.05 87.9329 1585.49 86.0007 1578.35 86.0007C1570.26 86.0007 1564.02 88.6136 1559.59 93.8175C1555.16 99.0214 1552.96 106.443 1552.96 116.104V199.301H1517.41L1517.37 199.213Z" fill="#1C2026"/> +<path d="M1810.8 203.185C1796.88 203.185 1784.38 200.352 1773.27 194.665C1762.17 188.978 1753.42 180.744 1747.02 169.963C1740.63 159.182 1737.42 146.206 1737.42 131.077V126.532C1737.42 111.381 1740.61 98.4263 1747.02 87.6453C1753.42 76.8642 1762.17 68.6302 1773.27 62.9433C1784.36 57.2563 1796.88 54.4238 1810.8 54.4238C1824.72 54.4238 1837.23 57.2563 1848.33 62.9433C1859.42 68.6302 1868.17 76.8642 1874.58 87.6453C1880.97 98.4263 1884.16 111.403 1884.16 126.532V131.077C1884.16 146.227 1880.95 159.182 1874.58 169.963C1868.19 180.744 1859.44 188.978 1848.33 194.665C1837.23 200.352 1824.72 203.185 1810.8 203.185ZM1810.8 171.391C1821.71 171.391 1830.72 167.833 1837.88 160.741C1845.04 153.649 1848.59 143.461 1848.59 130.221V127.388C1848.59 114.148 1845.06 103.96 1838.01 96.8674C1830.96 89.7751 1821.89 86.2181 1810.78 86.2181C1799.67 86.2181 1790.84 89.7751 1783.7 96.8674C1776.54 103.96 1772.99 114.148 1772.99 127.388V130.221C1772.99 143.461 1776.54 153.649 1783.7 160.741C1790.86 167.833 1799.87 171.391 1810.78 171.391H1810.8Z" fill="#1C2026"/> +<path d="M1902.77 199.211V58.399H1937.75V74.2961H1942.83C1944.91 68.6092 1948.33 64.4592 1953.13 61.8024C1957.93 59.1456 1963.52 57.8281 1969.91 57.8281H1986.84V89.6224H1969.34C1960.31 89.6224 1952.89 92.0377 1947.07 96.8683C1941.24 101.699 1938.32 109.12 1938.32 119.155V199.211H1902.77Z" fill="#1C2026"/> +<path d="M2015.62 255.994V224.771H2091.79C2097.05 224.771 2099.69 221.939 2099.69 216.252V180.769H2094.61C2093.1 183.996 2090.75 187.202 2087.56 190.43C2084.35 193.658 2080.03 196.292 2074.58 198.378C2069.12 200.464 2062.16 201.496 2053.7 201.496C2042.79 201.496 2033.23 198.993 2025.07 193.965C2016.89 188.959 2010.54 181.998 2006.02 173.106C2001.5 164.213 1999.26 153.981 1999.26 142.453V58.4004H2034.8V139.599C2034.8 150.204 2037.38 158.153 2042.57 163.444C2047.74 168.736 2055.11 171.393 2064.72 171.393C2075.63 171.393 2084.09 167.748 2090.11 160.458C2096.14 153.168 2099.15 143.002 2099.15 129.937V58.4004H2134.69V224.2C2134.69 233.861 2131.88 241.569 2126.23 247.343C2120.57 253.118 2113.05 255.994 2103.66 255.994H2015.64H2015.62Z" fill="#1C2026"/> +</svg> diff --git a/apps/web/public/mcp.png b/apps/web/public/mcp.png Binary files differindex 05ceb619..1bb3846a 100644 --- a/apps/web/public/mcp.png +++ b/apps/web/public/mcp.png |