From acb95b44ce25385bb7239c65748cb16752817a1c Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:53:30 +0000 Subject: [PATCH] docs: add `package-info.java` and `readme.md` For `API/CheerpJ` --- src/com/plantuml/api/cheerpj/package-info.java | 7 +++++++ src/com/plantuml/api/cheerpj/readme.md | 16 ++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 src/com/plantuml/api/cheerpj/package-info.java create mode 100644 src/com/plantuml/api/cheerpj/readme.md diff --git a/src/com/plantuml/api/cheerpj/package-info.java b/src/com/plantuml/api/cheerpj/package-info.java new file mode 100644 index 000000000..e7424d958 --- /dev/null +++ b/src/com/plantuml/api/cheerpj/package-info.java @@ -0,0 +1,7 @@ +/** + * Provides classes used to manage PlantUML with the + * + * CheerpJ API. + * + */ +package cheerpj; diff --git a/src/com/plantuml/api/cheerpj/readme.md b/src/com/plantuml/api/cheerpj/readme.md new file mode 100644 index 000000000..b2e105d15 --- /dev/null +++ b/src/com/plantuml/api/cheerpj/readme.md @@ -0,0 +1,16 @@ +# Directory Documentation for `cheerpj` + +## Description +This package provides classes used to manage [CheerpJ](https://labs.leaningtech.com/cheerpj3) API. + +## Reference +- [CheerpJ](https://labs.leaningtech.com/cheerpj3) + +## Use by +- :octocat: [plantuml/plantuml-core](https://github.com/plantuml/plantuml-core) + - on [`/plantuml-core/src/main/java`](https://github.com/plantuml/plantuml-core/tree/main/plantuml-core/src/main/java) +- :octocat: [plantuml/plantuml.js](https://github.com/plantuml/plantuml.js) + +## Demonstration +- [`plantuml-core/raw.html`](https://plantuml.github.io/plantuml-core/raw.html) +- [`plantuml.js`](https://plantuml.github.io/plantuml.js/)