Skip to content

Commit

Permalink
docs: readme simplification
Browse files Browse the repository at this point in the history
  • Loading branch information
John Carmichael committed Dec 30, 2023
1 parent 1f00845 commit 619f4a8
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,35 @@

![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)

[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)
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 619f4a8

Please sign in to comment.