update: refine README.md examples, remove sensitive placeholders, and simplify branding in documentation

.gitignore

@@ -20,13 +20,13 @@ yarn-error.log*
 .env.production.local
 
 # IDE files
-.vscode/*
+.vscode/
-# WebStorm files to ignore
+.idea/
-.idea/workspace.xml
+*.iml
-.idea/usage.statistics.xml
+*.iws
-.idea/dictionaries
+*.ipr
-.idea/shelf
+*.sublime-workspace
-# Include other WebStorm project files
+*.sublime-project
 
 # OS files
 .DS_Store

CONTRIBUTING.md

@@ -1,11 +1,11 @@
 <div align="center">
-<img src="https://raw.githubusercontent.com/soulcraft-research/brainy/main/brainy.png" alt="Brainy Logo" width="200"/>
+<img src="./brainy.png" alt="Brainy Logo" width="200"/>
 
-# Contributing to Soulcraft Brainy
+# Contributing to Brainy
 
 </div>
 
-Thank you for your interest in contributing to Soulcraft Brainy! This document provides guidelines and instructions for
+Thank you for your interest in contributing to Brainy! This document provides guidelines and instructions for
 contributing to the project.
 
 ## Commit Message Guidelines
@@ -48,4 +48,4 @@ Update build dependencies
 3. Build the project: `npm run build`
 4. Run tests: `npm test`
 
-Thank you for contributing to Soulcraft Brainy!
+Thank you for contributing to Brainy!

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Sodal
+Copyright (c) 2025 Soulcraft Research
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -629,12 +629,12 @@ const db = new BrainyData({
     // Storage configuration
     storage: {
         requestPersistentStorage: true,
-        // Uncomment to use cloud storage:
+        // Example configuration for cloud storage (replace with your own values):
         // s3Storage: {
-        //   bucketName: 'your-bucket',
+        //   bucketName: 'your-s3-bucket-name',
-        //   accessKeyId: 'your-key',
+        //   region: 'your-aws-region'
-        //   secretAccessKey: 'your-secret',
+        //   // Credentials should be provided via environment variables
-        //   region: 'us-east-1'
+        //   // AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
         // }
     }
 })
@@ -697,8 +697,8 @@ To get started with cloud deployment, see the [Cloud Wrapper README](cloud-wrapp
 
 ## 🔗 Related Projects
 
-- **[sodal-project cartographer](https://github.com/sodal-project/cartographer)** - The defacto standard for interacting
+- **[Cartographer](https://github.com/sodal-project/cartographer)** - A companion project that provides standardized 
-  with Brainy
+  interfaces for interacting with Brainy
 
 ## 📚 Examples
 
@@ -741,9 +741,10 @@ const wsConduit = await createConduitAugmentation('websocket', 'my-websocket-syn
 augmentationPipeline.register(wsConduit)
 
 // Connect to another Brainy instance (server or browser)
+// Replace the example URL below with your actual WebSocket server URL
 const connectionResult = await augmentationPipeline.executeConduitPipeline(
     'establishConnection',
-    ['wss://your-websocket-server.com/brainy-sync', {protocols: 'brainy-sync'}]
+    ['wss://example-websocket-server.com/brainy-sync', {protocols: 'brainy-sync'}]
 )
 
 if (connectionResult[0] && (await connectionResult[0]).success) {
@@ -795,14 +796,15 @@ const webrtcConduit = await createConduitAugmentation('webrtc', 'my-webrtc-sync'
 augmentationPipeline.register(webrtcConduit)
 
 // Connect to a peer using a signaling server
+// Replace the example values below with your actual configuration
 const connectionResult = await augmentationPipeline.executeConduitPipeline(
     'establishConnection',
     [
-        'peer-id-to-connect-to',
+        'peer-id-to-connect-to', // Replace with actual peer ID
         {
-            signalServerUrl: 'wss://your-signal-server.com',
+            signalServerUrl: 'wss://example-signal-server.com', // Replace with your signal server
-            localPeerId: 'my-peer-id',
+            localPeerId: 'my-local-peer-id', // Replace with your local peer ID
-            iceServers: [{urls: 'stun:stun.l.google.com:19302'}]
+            iceServers: [{urls: 'stun:stun.l.google.com:19302'}] // Public STUN server
         }
     ]
 )
@@ -850,9 +852,10 @@ searches against the local instance:
 import {BrainyData} from '@soulcraft/brainy'
 
 // Create and initialize the database with remote server configuration
+// Replace the example URL below with your actual Brainy server URL
 const db = new BrainyData({
     remoteServer: {
-        url: 'wss://your-brainy-server.com/ws',
+        url: 'wss://example-brainy-server.com/ws', // Replace with your server URL
         protocols: 'brainy-sync',
         autoConnect: true // Connect automatically during initialization
     }
@@ -861,7 +864,8 @@ await db.init()
 
 // Or connect manually after initialization
 if (!db.isConnectedToRemoteServer()) {
-    await db.connectToRemoteServer('wss://your-brainy-server.com/ws', 'brainy-sync')
+    // Replace the example URL below with your actual Brainy server URL
+    await db.connectToRemoteServer('wss://example-brainy-server.com/ws', 'brainy-sync')
 }
 
 // Search the remote server (results are stored locally)