Browse Source

[improvement] VS Code extension README (#379)

* Add screenshots, gif

* Add screenshot to main README

* Update README.md

* Update README.md
main
Steve Ruiz 2 years ago
parent
commit
a61e8ace65
No account linked to committer's email address

+ 3
- 2
README.md View File

@@ -2,7 +2,9 @@
2 2
   <img src="./assets/tldraw.png"/>
3 3
 </div>
4 4
 
5
-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.
5
+![A screenshot of the tldraw web app](./assets/screenshot.png)
6
+
7
+Welcome to the [tldraw](https://tldraw.com) monorepo.
6 8
 
7 9
 🙌 Questions? Join the [Discord channel](https://discord.gg/SBBEVCA4PG) or start a [discussion](https://github.com/tldraw/tldraw/discussions/new).
8 10
 
@@ -16,7 +18,6 @@ Thanks to our corporate sponsors:
16 18
 
17 19
 ...and to our [individual sponsors](https://github.com/sponsors/steveruizok#sponsors)!
18 20
 
19
-
20 21
 <!-- sponsors --><!-- sponsors -->
21 22
 
22 23
 ## Contents

+ 5
- 9
apps/vscode/extension/README.md View File

@@ -2,13 +2,13 @@
2 2
 
3 3
 tldraw extends VS Code with support for [tldraw](https://tldraw.com) files.
4 4
 
5
-[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.
5
+![A screenshot of tldraw in VS Code](./assets/screenshot.png)
6 6
 
7
-> **Tip:** The files you create or edit here can also be opened in the tldraw [web app](https://tldraw.com).
7
+[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.
8 8
 
9
-## Installation
9
+<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;"/>
10 10
 
11
-You can install tldraw from the Visual Studio Code Marketplace or by searching within VS Code.
11
+> **Tip:** The files you create or edit here can also be opened in the tldraw [web app](https://tldraw.com).
12 12
 
13 13
 ## Features
14 14
 
@@ -19,15 +19,11 @@ You can install tldraw from the Visual Studio Code Marketplace or by searching w
19 19
 - To view an existing tldraw file, open a file with the `.tldr` extension in VS Code.
20 20
 - To create a new tldraw file, use the provided command: "tldraw: New tldraw File".
21 21
 
22
-## Release Notes
23
-
24
-For full release notes, see the [changelog](https://github.com/tldraw/tldraw).
25
-
26 22
 ## Community
27 23
 
28 24
 ### Support
29 25
 
30
-Need help? Please [open an issue](https://github.com/tldraw/tldraw/issues/new) for support.
26
+Need help? Please [open an issue](https://github.com/tldraw/tldraw/issues/new/choose) for support.
31 27
 
32 28
 ### Discussion
33 29
 

BIN
apps/vscode/extension/assets/recording.gif View File


BIN
apps/vscode/extension/assets/screenshot.png View File


BIN
assets/screenshot.png View File


Loading…
Cancel
Save