braid-blob 0.0.15 → 0.0.16

package/LICENSE.txt

@@ -0,0 +1,11 @@
+Invisible Property License
+
+   1. You have the right to use this IP for any purpose.
+   2. If you make profit, you agree to give back a fair share of the profit to
+      the creators of this IP.
+   3. The creators will tell you how much they think is a fair share, if your
+      usage matters to them, and promise not to take you to court to enforce
+      the agreement.
+
+(In other words, this license thus runs on the honor system.  You are invited
+to participate in our community with honor.)

package/README.md

@@ -1,5 +1,87 @@
 # braid-blob
-Blob Synchronization libraries over Braid-HTTP
+
+A simple, self-contained library for synchronizing binary blobs (files, images, etc.) over HTTP using [Braid-HTTP](https://braid.org). It provides real-time synchronization with last-write-wins (LWW) conflict resolution and persistent storage.
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install braid-blob
+```
+
+### Basic Server
+
+```javascript
+var braid_blob = require('braid-blob')
+
+require('http').createServer((req, res) => {
+    braid_blob.serve(req, res)
+}).listen(8888)
+```
+
+That's it! You now have a blob synchronization server.
+
+### Usage Examples
+
+First let's upload a file:
+```bash
+curl -X PUT -H "Content-Type: image/png" -T blob.png http://localhost:8888/image.png
+```
+
+View image in browser at http://localhost:8888/image.png
+
+To see updates, let's do a textual example for easy viewing:
+
+```
+curl -X PUT -H "Content-Type: text/plain" -d "hello" http://localhost:8888/text
+```
+
+Next, subscribe for updates:
+```
+curl -H "Subscribe: true" http://localhost:8888/text
+```
+
+Now, in another terminal, write over the file:
+```bash
+curl -X PUT -H "Content-Type: text/plain" -d "world" http://localhost:8888/text
+```
+
+Should see activity in the first terminal showing the update.
+
+```
+# Delete a file
+curl -X DELETE http://localhost:8888/text
+```
+
+## API
+
+### Configuration
+
+```javascript
+var braid_blob = require('braid-blob')
+
+// Set custom storage location (default: './braid-blob-db')
+braid_blob.db_folder = './custom_files_folder'
+
+// Set custom peer ID (default: auto-generated and persisted)
+braid_blob.peer = 'my-server-id'
+```
+
+### `braid_blob.serve(req, res, options)`
+
+Handles HTTP requests for blob storage and synchronization.
+
+**Parameters:**
+- `req` - HTTP request object
+- `res` - HTTP response object
+- `options` - Optional configuration object
+  - `key` - Override the resource key (default: URL path)
+
+**Supported HTTP Methods:**
+- `GET` - Retrieve a blob (with optional `Subscribe: true` header)
+- `PUT` - Store/update a blob
+- `DELETE` - Remove a blob
 
 ## Testing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braid-blob",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "Library for collaborative blobs over http using braid.",
   "author": "Braid Working Group",
   "repository": "braid-org/braid-blob",