@devicelink/dlink 0.3.0 → 0.3.2

package/README.md

@@ -1,6 +1,6 @@
 # @devicelink/dlink
 
-DeviceLink lets you share folders from your computer with AI assistants (like ChatGPT) safely. Nothing is uploaded to the cloud to sit on a server: files stay on your machine until you allow access, and you stay in control.
+DeviceLink lets you share folders from your computer with AI assistants (like ChatGPT) safely. Nothing is uploaded - files stay on your machine and are streamed in real-time with your explicit permission.
 
 ## Install
 
@@ -8,47 +8,58 @@ DeviceLink lets you share folders from your computer with AI assistants (like Ch
 npm install -g @devicelink/dlink
 ```
 
+Requires Node.js 20+.
+
 ## Quick start
 
-```bash
-# Sign in with your DeviceLink account
-dlink signin
+### 1. Create your account
 
-# Pick a folder to share
-dlink share /path/to/project
+Sign in at [devicelink.ai](https://devicelink.ai) with Google. A workspace is created for you automatically.
 
-# You're set: your AI can use that folder when you connect it through DeviceLink
+### 2. Run the agent
+
+```bash
+dlink
 ```
 
+The agent will open your browser to sign in with the same Google account. Once authenticated, your device is linked to your workspace. Choose a folder to share when prompted.
+
+### 3. Connect ChatGPT
+
+Add DeviceLink as an MCP integration in ChatGPT (chatgpt.com → Settings → Connected apps). Sign in with the same Google account. Ask ChatGPT to list your files using DeviceLink - you're all set.
+
 ## Commands
 
+Run `dlink` to start the interactive agent. Once running, you can use these commands in the console:
+
 | Command | What it does |
-|---------|----------------|
-| `dlink signin` | Sign in to DeviceLink |
-| `dlink signout` | Sign out on this computer |
-| `dlink share <path>` | Share a folder with your AI |
-| `dlink status` | See whether you're connected |
+|---------|-------------|
+| `signin` | Sign in to DeviceLink |
+| `signout` | Sign out on this device |
+| `stop` | Disconnect and exit |
 
 ## How it works
 
-1. **Sign in** with your account (you'll use your browser when asked).
-2. **Pick folders** you want the AI to be able to read.
-3. **Stay connected** so requests can reach your computer securely.
-4. **Use your AI** as usual: it can list and read files in the folders you shared.
-5. **Stop anytime**: sign out or disconnect if you want access to end.
+1. **Sign in** - the agent opens your browser for Google sign-in.
+2. **Approve your device** - confirm on the web UI that this device can connect.
+3. **Share folders** - choose which directories the AI can access.
+4. **Stay connected** - the agent maintains a secure WebSocket connection so tool calls reach your machine.
+5. **Use your AI** - ChatGPT can list, read, search, and grep files in your shared folders.
+6. **Stop anytime** - close the agent and all access stops instantly.
 
 ## Security & privacy
 
-- Your files are not kept on our servers for browsing; access happens when you're connected and allow it.
-- Your device is checked so only your account can use your shared folders.
-- Sign-in details are stored encrypted on this computer.
-- Shared folders are limited to what you picked, so the AI can't wander the rest of your disk.
-- Access is short-lived and refreshed automatically so old keys don't stick around.
+- Files are streamed in real-time - nothing is stored on our servers.
+- Each device is verified with Ed25519 cryptographic signatures.
+- Shared folders are sandboxed - the AI cannot access anything outside what you shared.
+- Path traversal and symlink escapes are blocked.
+- Credentials are stored encrypted on your machine.
+- Access tokens are short-lived and refreshed automatically.
 
-## Requirements
+## Links
 
-- [Node.js](https://nodejs.org/) version 20 or newer
-- Internet access to sign in and stay connected
+- Website: [devicelink.ai](https://devicelink.ai)
+- Support: [devicelink.ai/support](https://devicelink.ai/support)
 
 ## License