From 619f4a8cb2917d416a3a5339a42c43e0b94e70ad Mon Sep 17 00:00:00 2001 From: John Carmichael Date: Sat, 30 Dec 2023 19:34:59 +0000 Subject: [PATCH] docs: readme simplification --- README.md | 23 +++++++++++++---------- package-lock.json | 2 +- package.json | 2 +- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c682a1e2..548d1884 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,13 @@ ![Boats](boats.jpg) -Ab OpenAPI & AsyncAPI templating system with Nunjucks... write less YAML... do more. +An OpenAPI & AsyncAPI templating system with Nunjucks... write less YAML... do more. ___ ## Quick start -- Create a new project, `npm init -y` -- Run BOATS init, `npx boats --init`, follow prompts +1. Initialize a new project: npm init -y +2. Set up BOATS: npx boats --init (follow the prompts) +3. Build the project: npm run build (outputs in ./build) ## Docs & Changelog [Full documentation](https://j-d-carmichael.github.io/boats) @@ -15,19 +16,21 @@ ___ [Changelog](https://j-d-carmichael.github.io/boats/#/?id=changelog) ## Examples -Example files can be found here, but please also read the docs: -- Async API: https://github.com/j-d-carmichael/boats/tree/master/srcASYNC2 -- Open API 2: https://github.com/j-d-carmichael/boats/tree/master/srcOA2 -- Open API 3: https://github.com/j-d-carmichael/boats/tree/master/srcOA3 +Simple examples can be found here: +- [Async API](https://github.com/j-d-carmichael/boats/tree/main/init-files/asyncapi) +- [Open API 2](https://github.com/j-d-carmichael/boats/tree/main/init-files/oa2) +- [Open API 3](https://github.com/j-d-carmichael/boats/tree/master/srcOA3) + +(Refer to the [documentation](https://j-d-carmichael.github.io/boats) for additional features and details.) ## Thanks To -BOATS is nothing without the support of everyone involved, so a big thanks to: +BOATS is nothing without the support of: - Every [contributor](https://github.com/j-d-carmichael/boats/graphs/contributors) & [issue](https://github.com/j-d-carmichael/boats/issues)! -- Jetbrains for their [Open Source Development - Community Support](https://www.jetbrains.com/community/opensource/#support)! - [@apidevtools](https://github.com/APIDevTools) - [@asyncapi](https://github.com/asyncapi) - [js-yaml](https://github.com/nodeca/js-yaml) -- Mozilla for [Nujucks](https://github.com/mozilla/nunjucks) +- Mozilla [Nujucks](https://github.com/mozilla/nunjucks) +- Jetbrains [Open Source Development - Community Support](https://www.jetbrains.com/community/opensource/#support)! [![Jetbrains](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/community/opensource/#support) [![GitHub](https://github.com/githubassets/images/modules/dashboard/onboarding/gh-desktop.png)](https://github.com/) [![apidevtools](https://github.com/avatars/u/43750074?s=200&v=4)](https://github.com/APIDevTools) [![asyncapi](https://github.com/avatars/u/16401334?s=200&v=4)](https://github.com/asyncapi) [![Nujucks](https://github.com/avatars/u/131524?s=200&v=4)](https://github.com/mozilla/nunjucks) diff --git a/package-lock.json b/package-lock.json index 1071280a..02099cce 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "boats", - "version": "4.10.0", + "version": "4.10.1", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/package.json b/package.json index 3c77dce5..3f94d1b6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "boats", - "version": "4.10.0", + "version": "4.10.1", "description": "Beautiful Open / Async Template System - Write less yaml with BOATS and Nunjucks.", "keywords": [ "asyncapi",