reladraw 0.15.1 → 0.17.0

package/README.md

@@ -25,27 +25,31 @@ reladraw sits between those two extremes, aiming to have the benefits of a diagr
 ```
 node app "Web app"
 node app.ui  "Interface"
-node app.api "API"  below app.ui
+node app.api "API"  below app.ui (gap: tight)
 
-node store "Database"  right of app  level with app
+node store "Database"  right of app (gap: 12)  even with app.api
 
-edge app.api -> store  "queries"  from: right  to: left
+edge app.api -> store  "queries"
 ```
 
+The tool draws what the file says and nothing else: a gap is the gap you wrote, and a line is straight unless you say how it bends or where it passes. It never moves a box to make room or routes a line round one. Where the picture may not read as you meant, such as a line crossing a box or two texts on top of each other, it draws it anyway and prints a one-line warning saying where and by how much, so you or your agent can fix the source.
+
 See also [SYNTAX.md](SYNTAX.md) and [examples/](examples/).
 
 ## Install
 
 ```
 npm install -g reladraw
-reladraw diagram.reladraw -o diagram.svg
+reladraw render diagram.reladraw -o diagram.svg
 ```
 
+`reladraw check diagram.reladraw` prints the warnings without writing a picture.
+
 Or from a clone, which also gets you the examples:
 
 ```
 npm install && npm run build
-node dist/cli.js examples/arch.reladraw -o out.svg
+node dist/cli.js render examples/arch.reladraw -o out.svg
 ```
 
 ## In a web page
@@ -82,7 +86,7 @@ That gets you a copy of the skill at the time you run it, so you'll need to re-r
 
 ## Status
 
-Version 0.15.1. Early stage, but works. The parser, layout engine, and SVG renderer are written in TypeScript, with zero runtime dependencies. There is a command-line tool that turns a .reladraw text file into an SVG, and an element that does the same inside a web page.
+Version 0.17.0. Early stage, but works. The parser, layout engine, and SVG renderer are written in TypeScript, with zero runtime dependencies. There is a command-line tool that turns a .reladraw text file into an SVG, and an element that does the same inside a web page.
 
 The language isn't stable yet, so expect the syntax to change.
 
@@ -92,4 +96,4 @@ Apache-2.0. See [LICENSE](LICENSE). The license covers the code, not the name. I
 
 ## Contributing
 
-Issues are welcome. Particularly helpful is a diagram you could not represent in reladraw. While the language is still changing quickly, an issue helps more than a pull request. See [CONTRIBUTING.md](CONTRIBUTING.md).
+Issues are welcome. Particularly helpful is a diagram you could not represent in reladraw. Pull requests are not accepted; please open an issue instead. See [CONTRIBUTING.md](CONTRIBUTING.md).