|
1 |
| -# Xata VSCode extension |
| 1 | +# [Xata](https://xata.io) [VS Code](https://code.visualstudio.com/) Extension |
2 | 2 |
|
3 |
| -Manage your xatabase schema without leaving VSCode! |
| 3 | +This extension enables users to work with [Xata](https://xata.io) without leaving Visual Studio Code. |
4 | 4 |
|
5 |
| -## Features |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +Once the extension is installed it from the [VS Code Marketplace](), it should show up in your Activity Bar like in the image below. |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +Clicking on any of the **Get Started** buttons should open your default browser. From there, login to your Xata account, and it will prompt you to create an [API key](https://docs.xata.io/concepts/api-keys). |
6 | 12 |
|
7 |
| -### Manage your xatabase |
| 13 | +Once the key is created, there will be a new prompt to return to VS Code and your **Explorer** pane should be populated with your workspaces. |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +## Features |
| 18 | +Here are some ways you can interact with Xata from our VS Code extension. |
| 19 | +### Manage Your Databases |
8 | 20 |
|
9 | 21 | Create workspaces, databases, branches and columns directly from the sidebar.
|
10 | 22 |
|
11 | 23 | 
|
12 | 24 |
|
13 |
| -### Insert & preview your records |
| 25 | +### Preview & Insert Records |
14 | 26 |
|
15 |
| -Insert your records with auto-completion / validation and preview them. |
| 27 | +Preview, then insert your records into a database of your choice on Xata with auto-completion and validation. |
16 | 28 |
|
17 | 29 | 
|
18 | 30 |
|
19 |
| -## Requirements |
| 31 | +After successfully inserting the record, you can save the file into your project for easy insertion in the future, or for sharing it with others: if they change the `"$schema"` parameter, the same record can be inserted into another database. |
20 | 32 |
|
21 |
| -You need to have a xata account & personal access token. https://xata.io/ |
| 33 | +--- |
22 | 34 |
|
23 |
| -**Enjoy!** |
| 35 | +Made by 🦋 |
0 commit comments