doc: include redocly cli

ripple · Nov 14, 2024 · 0b4586d · 0b4586d
1 parent 9ad277d
commit 0b4586d
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,5 +1,25 @@
 # XRP Ledger OpenAPI / AsyncAPI Specifications
 
+## Getting Started
+
+Install redocly cli:
+
+```bash
+npm i -g @redocly/cli
+```
+
+To bundle and get the final .yaml file:
+
+```bash
+npm run bundle
+```
+
+To preview the rendered spec in your browser:
+
+```bash
+npm run preview
+```
+
 ## Introduction & Motivation
 
 ```mermaid

diff --git a/package-lock.json b/package-lock.json