Skip to content

Commit 8a0ae6f

Browse files
author
Corey B
committed
docs(readme): explicit cli integration instructions, component usage details, and standardized social advocacy triggers
1 parent 9552fb6 commit 8a0ae6f

1 file changed

Lines changed: 45 additions & 1 deletion

File tree

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,48 @@ FDD adoption solves both infrastructure and data consumption bottlenecks. We bel
3333
4. **Interact Your Way**: FDD separates presentation from true data. View it with the built-in UI, load it into an office suite, use it for data modeling, query it directly in your coding IDE, or feed it to an AI Agent—the choice is yours.
3434
5. **Decentralized APIs**: Removes the massive root infrastructure cost of building API endpoints for institutions. Instead of building webhooks to support parallel and downstream industries (e.g. the mortgage industry needing bank statements, or colleges needing school records), institutions can simply issue a secure, verifiable `.fdd` file to the user.
3535

36-
Join us in creating the future of standard file formats.
36+
## Tooling & Ecosystem Guide
37+
The OpenFDD ecosystem provides a full suite of typescript/javascript libraries to securely compose, sign, view, and inherently interact with FDD files.
38+
39+
### 1. Composing & Building (`node-fdd`)
40+
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:
41+
```bash
42+
node lib/node-fdd/src/pack.js template.html fdd-data.json user-notes.json output.fdd
43+
```
44+
45+
### 2. Cryptographic Signing
46+
If you are the official Issuer (e.g. a Bank), you must mathematically sign the JSON payload before packing it:
47+
```bash
48+
node lib/node-fdd/src/sign.js path/to/privateKey.pem fdd-data.json
49+
```
50+
51+
### 3. Parsing & Viewing Natively (`fdd-js`)
52+
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!
53+
```html
54+
<script src="/path/to/lib/fdd-js/src/fdd.js"></script>
55+
```
56+
57+
### 4. Viewing Locally (`Chrome Extension`)
58+
For End-Users navigating to FDD files natively on their disk, the custom routing extension acts as a Security Shield. It intercepts raw text rendering to sandbox the format, gracefully bypasses restrictive OS bounds allowing direct file-system saves, and actively prunes malware requests!
59+
60+
---
61+
62+
## 📣 How You Can Help Advocate!
63+
The success of OpenFDD relies entirely on community pushback against static PDFs. Help spread the word!
64+
65+
**Share the Standard on Social Media:**
66+
<p align="left">
67+
<a href="https://twitter.com/intent/tweet?text=Stop%20sending%20dead%20PDFs.%20Documents%20should%20be%20data-first,%20not%20pictures%20of%20data.%20Learn%20why%20%23OpenFDD%20and%20Zero-JS%20interactive%20JSON-LD%20containers%20are%20the%20future%20of%20files!%20%20%0A%0A%F0%9F%93%84%20https://github.com/Spuds0588/open-fdd">
68+
<img src="https://img.shields.io/badge/Share%20on%20X-000000?style=for-the-badge&logo=x&logoColor=white" alt="Share on X" />
69+
</a>
70+
<a href="https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/Spuds0588/open-fdd">
71+
<img src="https://img.shields.io/badge/Share%20on%20LinkedIn-0077b5?style=for-the-badge&logo=linkedin&logoColor=white" alt="Share on LinkedIn" />
72+
</a>
73+
</p>
74+
75+
**Action Items for Devs:**
76+
1. **Pitch it to your PM:** If your app exports user dashboards as 'PDF Printouts', propose securely exporting a `.fdd` "mini-app" instead.
77+
2. **Build Integrations:** Build robust parsing libraries in Rust, Python, or Go for the `fdd-data` layer!
78+
3. **Star the Repo:** Help signal to the W3C and major browser vendors that developers want explicitly trusted, High-Trust File Sandbox permissions natively!
79+
80+
Join us in creating the future of standard file formatting.

0 commit comments

Comments
 (0)