@diagc/cli 0.13.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,8 +1,12 @@
1
1
  # diagc
2
2
 
3
- Author software-architecture diagrams as code, edit them in a local visual studio, and publish them as shareable pages and images.
3
+ Diagrams as code, with a local studio. diagc turns diagram sources that live in your repository into things other people can open.
4
4
 
5
- Diagrams are plain files in your repo, so they diff, review, and refactor like the rest of it.
5
+ - **Pages and pictures.** `diagc publish` writes one self-contained HTML page per diagram, and a PNG. The page folds, zooms and switches views in the browser, with no server behind it. Host the pages on GitHub Pages, GitLab Pages or any static host, and put the PNG in a README.
6
+ - **Diffs in pull requests.** A GitHub Action comments on a pull request that changes a diagram: the list of changes, and the before and after pictures.
7
+ - **A local studio.** `diagc studio` opens a browser app against your repository. Draw a diagram there and the studio saves it as a file in the repository. `diagc eject` turns a drawn diagram into TypeScript.
8
+
9
+ Diagrams are plain files in your repository, so they diff, review and refactor like the rest of it.
6
10
 
7
11
  ```bash
8
12
  npm i -g @diagc/cli # or: npx @diagc/cli studio
@@ -43,6 +47,8 @@ Commit `.diagrams/src/`. `.diagrams/.artifacts/`, `.diagrams/html/` and `.diagra
43
47
 
44
48
  ## Documentation
45
49
 
50
+ Website and live examples: <https://ferroman.github.io/diagc/>
51
+
46
52
  Full docs, tutorials, and the model reference: <https://github.com/Ferroman/diagc>
47
53
 
48
54
  ## License