Skip to content

Commit 9138743

Browse files
author
Corey B
committed
docs(npm): add dedicated readme instructions specifically tailored for the compiler release page and bump version
1 parent 7f6fd32 commit 9138743

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

lib/node-fdd/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# @coreyburns/node-fdd
2+
3+
The official CLI toolchain for composing, packing, and cryptographically signing Formatted Data Document (`.fdd`) layouts natively from your Node endpoint.
4+
5+
The `.fdd` MIME type is a zero-JS interactive document specification meant to replace visual-first static PDFs natively by routing HTML rendering via declarative logic rules binding Cryptographic VC Payloads directly to your canvas.
6+
7+
---
8+
9+
## ⚡ Global Installation
10+
```bash
11+
npm install -g @coreyburns/node-fdd
12+
```
13+
14+
## 🛠 Operation Workflows
15+
The OpenFDD compiler requires you to merge standard HTML Templates with a Cryptographic Data Payload into a secure FDD Container.
16+
17+
### 1. Generating & Packing an `.fdd` Context
18+
Wrap your immutable schema, an optional mutable tracking schema (like `user-notes.json`), and the presentation layout using `fdd-pack`.
19+
20+
```bash
21+
fdd-pack template.html fdd-data.json user-notes.json output.fdd
22+
```
23+
24+
### 2. Cryptographic Binding (Issuing)
25+
Officially binding a document enforces an Ed25519 trace mathematically tied to the JSON tree to ensure massive Verifiable Credential integrity mathematically.
26+
27+
```bash
28+
fdd-sign path/to/privateKey.pem fdd-data.json
29+
```
30+
31+
## 🌍 Ecosystem Links
32+
* [OpenFDD Specification (GitHub)](https://github.com/Spuds0588/open-fdd)
33+
* [Read the Web Manifesto](https://open-fdd.org)

lib/node-fdd/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@coreyburns/node-fdd",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"description": "Server-side utility for OpenFDD signing and packing",
55
"main": "src/pack.js",
66
"type": "module",

0 commit comments

Comments
 (0)