diff --git a/README.md b/README.md index 57c5ac4..37b92f9 100644 --- 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 index 3639f31..d927a9e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,7 +5,7 @@ "packages": { "": { "dependencies": { - "@redocly/portal-plugin-async-api": "^1.0.287", + "@redocly/portal-plugin-async-api": "^1.0.207", "@redocly/realm": "^0.108.2" }, "devDependencies": {