Merge pull request #65 from terrastruct/alixander/readme
readme: Update
This commit is contained in:
commit
8b1a40fed9
3 changed files with 20 additions and 22 deletions
38
README.md
38
README.md
|
|
@ -8,10 +8,9 @@
|
||||||
|
|
||||||
[](https://github.com/terrastruct/d2/actions/workflows/ci.yml)
|
[](https://github.com/terrastruct/d2/actions/workflows/ci.yml)
|
||||||
[](https://github.com/terrastruct/d2/releases)
|
[](https://github.com/terrastruct/d2/releases)
|
||||||
[](https://discord.gg/h9VFkAKTsT)
|
[](https://discord.gg/NF6X8K4eDq)
|
||||||

|
[](https://twitter.com/terrastruct)
|
||||||
[](./LICENSE.txt)
|
[](./LICENSE.txt)
|
||||||
[](https://pkg.go.dev/oss.terrastruct.com/d2)
|
|
||||||
|
|
||||||
<img src="./docs/assets/cli.gif" alt="D2 CLI" />
|
<img src="./docs/assets/cli.gif" alt="D2 CLI" />
|
||||||
|
|
||||||
|
|
@ -42,6 +41,7 @@
|
||||||
<!-- tocstop -->
|
<!-- tocstop -->
|
||||||
|
|
||||||
## Quickstart (CLI)
|
## Quickstart (CLI)
|
||||||
|
|
||||||
The most convenient way to use D2 is to just run it as a CLI executable to
|
The most convenient way to use D2 is to just run it as a CLI executable to
|
||||||
produce SVGs from `.d2` files.
|
produce SVGs from `.d2` files.
|
||||||
|
|
||||||
|
|
@ -65,6 +65,7 @@ page. D2 will be added to OS-respective package managers soon.
|
||||||
|
|
||||||
|
|
||||||
## Quickstart (library)
|
## Quickstart (library)
|
||||||
|
|
||||||
In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from
|
In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from
|
||||||
Go programs.
|
Go programs.
|
||||||
|
|
||||||
|
|
@ -168,23 +169,6 @@ Contributions are welcome! See [./docs/CONTRIBUTING.md](./docs/CONTRIBUTING.md).
|
||||||
Copyright © 2022 Terrastruct, Inc. Open-source licensed under the Mozilla Public License
|
Copyright © 2022 Terrastruct, Inc. Open-source licensed under the Mozilla Public License
|
||||||
2.0.
|
2.0.
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
D2 is light on third-party dependencies in the source code. Note that these are bundled
|
|
||||||
with D2, you do not have to separately install anything.
|
|
||||||
|
|
||||||
| Dependency | What it does |
|
|
||||||
| ----------- | ----------- |
|
|
||||||
| [slog](https://cdr.dev/slog) | logging (deprecating it is a TODO) |
|
|
||||||
| [goldmark](https://github.com/yuin/goldmark), [goquery](https://github.com/PuerkitoBio/goquery) | Markdown rendering |
|
|
||||||
| [chroma](https://github.com/alecthomas/chroma) | syntax highlighting code snippets |
|
|
||||||
| [pflag](https://github.com/spf13/pflag), [fsnotify](https://github.com/fsnotify/fsnotify), [websocket](https://nhooyr.io/websocket) | CLI functions |
|
|
||||||
| [v8go](https://rogchap.com/v8go) | Run Javascript (e.g. Dagre layout engine) |
|
|
||||||
| [gonum](https://gonum.org/v1/plot) | Bezier curve stuff (rendering) |
|
|
||||||
|
|
||||||
The rest are helpers we've open-sourced. E.g. [diff](https://oss.terrastruct.com/diff) for
|
|
||||||
our testing framework.
|
|
||||||
|
|
||||||
## Related
|
## Related
|
||||||
|
|
||||||
### VSCode extension
|
### VSCode extension
|
||||||
|
|
@ -199,3 +183,17 @@ our testing framework.
|
||||||
|
|
||||||
- [https://github.com/terrastruct/d2-docs](https://github.com/terrastruct/d2-docs)
|
- [https://github.com/terrastruct/d2-docs](https://github.com/terrastruct/d2-docs)
|
||||||
- [https://github.com/terrastruct/text-to-diagram-com](https://github.com/terrastruct/text-to-diagram-com)
|
- [https://github.com/terrastruct/text-to-diagram-com](https://github.com/terrastruct/text-to-diagram-com)
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
- Does D2 collect telemetry?
|
||||||
|
- No, D2 does not use an internet connection after installation, except to check for
|
||||||
|
version updates from Github periodically.
|
||||||
|
- I have a question or need help.
|
||||||
|
- The best way to get help is to open an Issue, so that it's searchable by others in the
|
||||||
|
future. If you prefer synchronous or just want to chat, you can pop into the help
|
||||||
|
channel of the [D2 Discord](https://discord.gg/NF6X8K4eDq) as well.
|
||||||
|
- I have a feature request or proposal.
|
||||||
|
- D2 uses Github Issues for everything. Just add a "discussion" label to your Issue.
|
||||||
|
- I have a private inquiry.
|
||||||
|
- Please reach out at [hi@d2lang.com](hi@d2lang.com).
|
||||||
|
|
|
||||||
|
|
@ -97,5 +97,5 @@ language docs:
|
||||||
### Questions
|
### Questions
|
||||||
|
|
||||||
If you have any questions or would like to get more involved, feel free to open an issue
|
If you have any questions or would like to get more involved, feel free to open an issue
|
||||||
to discuss publicly, or chat in [Discord](https://discord.gg/h9VFkAKTsT)! If you have a
|
to discuss publicly, or chat in [Discord](https://discord.gg/NF6X8K4eDq)! If you have a
|
||||||
private question, feel free to email us at d2@terrastruct.com.
|
private inquiry, feel free to email us at hi@d2lang.com.
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 134 KiB |
Loading…
Reference in a new issue