@termdraw/app 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ben Vinegar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @termdraw/app
+
+`@termdraw/app` is the standalone termDRAW terminal app for developers who want editable diagrams, UI mocks, and text graphics without leaving the terminal.
+
+## What it does
+
+- Draw boxes, lines, paint strokes, and text as retained objects.
+- Select, move, resize, and recolor objects after you draw them.
+- Group related content inside boxes while everything stays aligned to terminal cells.
+- Export plain text or fenced Markdown for docs, tickets, and prompts.
+
+## Install
+
+Requirements:
+
+- [Bun](https://bun.sh) 1.3+
+- A terminal with mouse support
+
+```bash
+npm install --global @termdraw/app
+```
+
+## Quick start
+
+```bash
+termdraw
+```
+
+Draw something, then press `Enter` or `Ctrl+S` to write the result to stdout.
+
+## Usage
+
+```bash
+# save plain text directly to a file
+termdraw --output diagram.txt
+
+# export a fenced Markdown code block
+termdraw --fenced > diagram.md
+
+# show CLI help
+termdraw --help
+```
+
+termDRAW! outputs terminal text, not SVG or bitmap graphics.
+
+## OpenTUI package
+
+If you want the embeddable OpenTUI components instead of the packaged app:
+
+```bash
+npm install @termdraw/opentui @opentui/core @opentui/react react
+```
+
+## Contributing
+
+Contributions are welcome.
+
+Before opening a PR:
+
+- keep the change focused
+- run `bun run check`
+- add or update tests when editor behavior changes
+- open an issue first for larger UX or API changes
+
+## Security
+
+Please report security issues privately through GitHub Security Advisories:
+
+- <https://github.com/benvinegar/termdraw/security/advisories/new>
+
+## License
+
+MIT. See [LICENSE](LICENSE).