Skip to content

Commit 53c75ab

Browse files
author
Corey B
committed
build: mapping global documentation to explicit Open Source distribution channels (npm & jsdelivr CDN)
1 parent 558fe19 commit 53c75ab

4 files changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,24 @@ The OpenFDD ecosystem provides a full suite of typescript/javascript libraries t
4040
### 1. Composing & Building (`node-fdd`)
4141
To build an `.fdd` file from your backend, you pack your Cryptographic JSON, your Mutable JSON, and your HTML template securely into the unified `.fdd` document wrapper:
4242
```bash
43-
node lib/node-fdd/src/pack.js template.html fdd-data.json user-notes.json output.fdd
43+
# Install the Official OpenFDD CLI globally
44+
npm install -g node-fdd
45+
46+
# Pack the payload securely into the FDD container
47+
fdd-pack template.html fdd-data.json user-notes.json output.fdd
4448
```
4549

4650
### 2. Cryptographic Signing
4751
If you are the official Issuer (e.g. a Bank), you must mathematically sign the JSON payload before packing it:
4852
```bash
49-
node lib/node-fdd/src/sign.js path/to/privateKey.pem fdd-data.json
53+
fdd-sign path/to/privateKey.pem fdd-data.json
5054
```
5155

5256
### 3. Parsing & Viewing Natively (`fdd-js`)
53-
To seamlessly render `.fdd` containers natively on your own web-platform without requiring plugins, simply reference the native layout library within your DOM. It evaluates the No-JS constraints, routes Ephemeral State actions securely, and renders the Document safely!
57+
To seamlessly render `.fdd` containers natively on your own web-platform without requiring plugins, simply reference the native layout library via our global jsDelivr CDN inside your DOM. It evaluates the No-JS constraints, routes Ephemeral State actions securely, and renders the Document safely!
5458
```html
55-
<script src="/path/to/lib/fdd-js/src/fdd.js"></script>
59+
<!-- Hosted securely out of explicit version tags to prevent un-authorized layout breaking -->
60+
<script src="https://cdn.jsdelivr.net/gh/Spuds0588/open-fdd@v1.1.0/lib/fdd-js/src/fdd.js"></script>
5661
```
5762

5863
### 4. Viewing Locally (`Chrome Extension`)

examples/court_judgment.fdd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
.history { list-style-type: none; padding: 0; font-size: 1.1rem; }
4343
.history li { border-left: 3px solid #ccc; margin-bottom: 10px; padding-left: 15px; }
4444
.history .date { font-weight: bold; color: #444; margin-right: 15px;}
45-
.notes-area { width: 100%; height: 80px; margin-top: 5px; box-sizing: border-box; border-radius: 8px; border: 1px dashed #cbd5e1; padding: 10px; font-family: Arial; resize: none; background: #fdfdfd;}
45+
.notes-area { width: 100%; height: 80px; margin-top: 5px; box-sizing: border-box; border-radius: 8px; border: 1px dashed #cbd5e1; padding: 10px; font-family: Arial; resize: none; background: #fdfdfd; color: #111;}
4646
</style>
4747
<div class="verified">✓ Official Court Record • Cryptographically Sealed Header</div>
4848
<h1 style="text-transform: uppercase;">State of Minnesota</h1>

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": "node-fdd",
3-
"version": "1.0.0",
3+
"version": "1.1.0",
44
"description": "Server-side utility for OpenFDD signing and packing",
55
"main": "src/pack.js",
66
"type": "module",

site/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,15 +178,15 @@ <h2>Tooling & Ecosystem Guide</h2>
178178
<ul class="points-list">
179179
<li>
180180
<strong>1. Composing & Building (<code>node-fdd</code>)</strong>
181-
To build an `.fdd` file from your backend, you seamlessly pack your Cryptographic JSON, your Mutable JSON, and your HTML template securely into the unified wrapper using the CLI runtime pipeline.
181+
To build an `.fdd` file natively on your backend, utilize the official <code>npm install -g node-fdd</code> library. You seamlessly pass your Cryptographic JSON, your Mutable JSON, and your HTML template securely via the <code>fdd-pack</code> CLI pipeline.
182182
</li>
183183
<li>
184184
<strong>2. Cryptographic Signing</strong>
185-
Official Issuers securely map Ed25519 signatures hashing the exact JSON payload blocks guaranteeing complete 100% data integrity bindings.
185+
Official Issuers simply bind Ed25519 signatures directly against the <code>#fdd-data</code> block using the <code>fdd-sign</code> utility, guaranteeing mathematically verified data integrity.
186186
</li>
187187
<li>
188188
<strong>3. Parsing & Viewing Natively (<code>fdd-js</code>)</strong>
189-
Seamlessly render `.fdd` containers natively on your own web-platform by referencing the native library within your DOM. It evaluates No-JS constraints and securely routes Ephemeral State actions dynamically.
189+
To seamlessly render `.fdd` single-file applications effortlessly inside your own products, simply load the native parser via the global CDN! Pinning the tag to the verified release (e.g., <code>https://cdn.jsdelivr.net/gh/Spuds0588/open-fdd@v1.1.0/lib/fdd-js/src/fdd.js</code>) guarantees flawless declarative constraint routing!
190190
</li>
191191
<li>
192192
<strong>4. Viewing Locally (`Chrome Extension`)</strong>

0 commit comments

Comments
 (0)