diff --git a/README.md b/README.md index 52427f33a..f4f5f7148 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,9 @@ [![ci](https://github.com/terrastruct/d2/actions/workflows/ci.yml/badge.svg)](https://github.com/terrastruct/d2/actions/workflows/ci.yml) [![release](https://img.shields.io/github/v/release/terrastruct/d2)](https://github.com/terrastruct/d2/releases) -[![discord](https://img.shields.io/discord/976899413542830181?label=discord)](https://discord.gg/h9VFkAKTsT) -![twitter](https://img.shields.io/twitter/follow/terrastruct?style=social) +[![discord](https://img.shields.io/discord/1039184639652265985?label=discord)](https://discord.gg/NF6X8K4eDq) +[![twitter](https://img.shields.io/twitter/follow/terrastruct?style=social)](https://twitter.com/terrastruct) [![license](https://img.shields.io/github/license/terrastruct/d2?color=9cf)](./LICENSE.txt) -[![godoc](https://pkg.go.dev/badge/oss.terrastruct.com/d2.svg)](https://pkg.go.dev/oss.terrastruct.com/d2) D2 CLI @@ -42,6 +41,7 @@ ## Quickstart (CLI) + The most convenient way to use D2 is to just run it as a CLI executable to produce SVGs from `.d2` files. @@ -65,6 +65,7 @@ page. D2 will be added to OS-respective package managers soon. ## Quickstart (library) + In addition to being a runnable CLI tool, D2 can also be used to produce diagrams from 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 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 ### 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/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). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index c52a45c14..41c82f89a 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -97,5 +97,5 @@ language docs: ### Questions 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 -private question, feel free to email us at d2@terrastruct.com. +to discuss publicly, or chat in [Discord](https://discord.gg/NF6X8K4eDq)! If you have a +private inquiry, feel free to email us at hi@d2lang.com. diff --git a/docs/assets/themes_overview.png b/docs/assets/themes_overview.png index 333023c29..676057125 100644 Binary files a/docs/assets/themes_overview.png and b/docs/assets/themes_overview.png differ