Add readme

Author: leonardocustodio

.github/workflows/deploy-playground.yml

@@ -33,6 +33,9 @@ jobs:
       - name: Build all packages
         run: bun run build
 
+      - name: Generate static site for Playground
+        run: cd apps/playground && bun run generate
+
       - name: Setup Pages
         uses: actions/configure-pages@v5
 

README.md

@@ -1 +1,62 @@
-# Blockchain Commons TypeScript
+# Blockchain Commons - TypeScript
+
+A comprehensive TypeScript monorepo implementing Blockchain Commons specifications for cryptographic data encoding, privacy-preserving envelopes, and secure information structures.
+
+This repository contains TypeScript implementations of specifications developed by [Blockchain Commons](https://www.blockchaincommons.com/), a research and development cooperative of blockchain and digital asset developers.
+
+## 📦 Packages
+
+### Core Libraries
+
+| Package | Description | Version |
+|---------|-------------|---------|
+| [**dcbor**](packages/dcbor) | Deterministic CBOR encoding - a specification for serializing data in a canonical, reproducible format. Ensures identical byte sequences for cryptographic operations and blockchain applications. [📖 API Docs](https://leonardocustodio.github.io/bc-dcbor-ts/) | `1.0.0-alpha.1` |
+| [**envelope**](packages/envelope) | Gordian Envelope - privacy-preserving data structures with encryption, elision (selective redaction), and cryptographic signatures. Includes prelude submodule for advanced operations. | `1.0.0-alpha.1` |
+
+## 🎮 Applications
+
+### [Playground](apps/playground)
+An interactive web application for experimenting with dCBOR encoding, Envelope creation, and cryptographic operations.
+
+**Live Demo:** https://leonardocustodio.github.io/blockchain-commons
+
+**Try it locally:**
+```bash
+bun dev
+```
+
+## 🚀 Quick Start
+
+### Prerequisites
+- Node.js >= 16.0.0
+- [Bun](https://bun.sh/) (>=1.2.22) - Package manager and runtime
+
+### Installation
+
+```bash
+# Install dependencies
+bun install
+
+# Build all packages
+bun run build
+
+# Run development servers
+bun run dev
+
+# Run linting
+bun run lint
+
+# Type checking
+bun run check-types
+```
+
+## 📚 Specifications & Reference Implementations
+
+This project implements open specifications maintained by Blockchain Commons:
+
+- **[Deterministic CBOR (dCBOR)](https://github.com/BlockchainCommons/bc-dcbor-rust)** - A deterministic binary encoding format based on CBOR (RFC 7049)
+- **[Gordian Envelope](https://github.com/BlockchainCommons/bc-envelope-rust)** - A privacy-preserving data structure specification with encryption, elision, and signature support
+
+For complete specifications and reference implementations in other languages, visit:
+- [Blockchain Commons GitHub](https://github.com/BlockchainCommons)
+- [Blockchain Commons Documentation](https://www.blockchaincommons.com/)

apps/playground/nuxt.config.ts

@@ -7,4 +7,7 @@ export default defineNuxtConfig({
   ],
   css: ['~/assets/css/main.css'],
   devtools: { enabled: true },
+  app: {
+    baseURL: '/blockchain-commons-ts/',
+  },
 })

packages/dcbor/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockchain-commons/dcbor",
-  "version": "2.1.0",
+  "version": "1.0.0-alpha.1",
   "type": "module",
   "description": "Blockchain Commons Deterministic CBOR (dCBOR) for TypeScript",
   "main": "dist/index.cjs",

packages/envelope/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockchain-commons/envelope",
-  "version": "0.41.0",
+  "version": "1.0.0-alpha.1",
   "type": "module",
   "description": "Gordian Envelope for TypeScript",
   "main": "dist/index.cjs",