[improvement] VS Code extension README (#379)
* Add screenshots, gif * Add screenshot to main README * Update README.md * Update README.md
This commit is contained in:
parent
73cb5b3ec1
commit
a61e8ace65
5 changed files with 8 additions and 11 deletions
|
@ -2,7 +2,9 @@
|
||||||
<img src="./assets/tldraw.png"/>
|
<img src="./assets/tldraw.png"/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
Welcome to the [tldraw](https://tldraw.com) monorepo. Here you'll find the source code for [@tldraw/tldraw](https://www.npmjs.com/package/@tldraw/tldraw), [@tldraw/core](https://www.npmjs.com/package/@tldraw/core), and the tldraw.com website.
|
![A screenshot of the tldraw web app](./assets/screenshot.png)
|
||||||
|
|
||||||
|
Welcome to the [tldraw](https://tldraw.com) monorepo.
|
||||||
|
|
||||||
🙌 Questions? Join the [Discord channel](https://discord.gg/SBBEVCA4PG) or start a [discussion](https://github.com/tldraw/tldraw/discussions/new).
|
🙌 Questions? Join the [Discord channel](https://discord.gg/SBBEVCA4PG) or start a [discussion](https://github.com/tldraw/tldraw/discussions/new).
|
||||||
|
|
||||||
|
@ -16,7 +18,6 @@ Thanks to our corporate sponsors:
|
||||||
|
|
||||||
...and to our [individual sponsors](https://github.com/sponsors/steveruizok#sponsors)!
|
...and to our [individual sponsors](https://github.com/sponsors/steveruizok#sponsors)!
|
||||||
|
|
||||||
|
|
||||||
<!-- sponsors --><!-- sponsors -->
|
<!-- sponsors --><!-- sponsors -->
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
|
@ -2,14 +2,14 @@
|
||||||
|
|
||||||
tldraw extends VS Code with support for [tldraw](https://tldraw.com) files.
|
tldraw extends VS Code with support for [tldraw](https://tldraw.com) files.
|
||||||
|
|
||||||
|
![A screenshot of tldraw in VS Code](./assets/screenshot.png)
|
||||||
|
|
||||||
[tldraw](https://tldraw.com) is a free drawing and diagramming tool with a hand-drawn style and convenient features such as smart arrows, snapping, and sticky notes. With the tldraw extension for VS Code, your tldraw files can be version controlled alongside your code.
|
[tldraw](https://tldraw.com) is a free drawing and diagramming tool with a hand-drawn style and convenient features such as smart arrows, snapping, and sticky notes. With the tldraw extension for VS Code, your tldraw files can be version controlled alongside your code.
|
||||||
|
|
||||||
|
<img alt="A recording of tldraw in VS Code" src="./assets/recording.gif" style="border-radius: 8px 8px 8px 8px; overflow: hidden; box-shadow: 0px 2px 24px rgba(0,0,0,.6);margin: 24px;"/>
|
||||||
|
|
||||||
> **Tip:** The files you create or edit here can also be opened in the tldraw [web app](https://tldraw.com).
|
> **Tip:** The files you create or edit here can also be opened in the tldraw [web app](https://tldraw.com).
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
You can install tldraw from the Visual Studio Code Marketplace or by searching within VS Code.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
1. View, edit and save tldraw files (`.tldr`)
|
1. View, edit and save tldraw files (`.tldr`)
|
||||||
|
@ -19,15 +19,11 @@ You can install tldraw from the Visual Studio Code Marketplace or by searching w
|
||||||
- To view an existing tldraw file, open a file with the `.tldr` extension in VS Code.
|
- To view an existing tldraw file, open a file with the `.tldr` extension in VS Code.
|
||||||
- To create a new tldraw file, use the provided command: "tldraw: New tldraw File".
|
- To create a new tldraw file, use the provided command: "tldraw: New tldraw File".
|
||||||
|
|
||||||
## Release Notes
|
|
||||||
|
|
||||||
For full release notes, see the [changelog](https://github.com/tldraw/tldraw).
|
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
|
|
||||||
### Support
|
### Support
|
||||||
|
|
||||||
Need help? Please [open an issue](https://github.com/tldraw/tldraw/issues/new) for support.
|
Need help? Please [open an issue](https://github.com/tldraw/tldraw/issues/new/choose) for support.
|
||||||
|
|
||||||
### Discussion
|
### Discussion
|
||||||
|
|
||||||
|
|
BIN
apps/vscode/extension/assets/recording.gif
Normal file
BIN
apps/vscode/extension/assets/recording.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.4 MiB |
BIN
apps/vscode/extension/assets/screenshot.png
Normal file
BIN
apps/vscode/extension/assets/screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 80 KiB |
BIN
assets/screenshot.png
Normal file
BIN
assets/screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 178 KiB |
Loading…
Reference in a new issue