Skip to content
This repository was archived by the owner on Jan 2, 2024. It is now read-only.

Commit 5999a19

Browse files
authored
Merge pull request #33 from xataio/docs/get-started
Readme: Get Started section
2 parents c906c9a + bbcde1d commit 5999a19

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,35 @@
1-
# Xata VSCode extension
1+
# [Xata](https://xata.io) [VS Code](https://code.visualstudio.com/) Extension
22

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.
44

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+
![Setup view for the VSCode Extension](https://github.com/xataio/vscode-extension/raw/main/doc/get-started-view.png)
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).
612

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+
![List of workspaces on Xata VSCode Extension](https://github.com/xataio/vscode-extension/raw/main/doc/workspaces-view.png)
16+
17+
## Features
18+
Here are some ways you can interact with Xata from our VS Code extension.
19+
### Manage Your Databases
820

921
Create workspaces, databases, branches and columns directly from the sidebar.
1022

1123
![create-schema](https://github.com/xataio/vscode-extension/raw/main/doc/create-schema.gif)
1224

13-
### Insert & preview your records
25+
### Preview & Insert Records
1426

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.
1628

1729
![insert-record](https://github.com/xataio/vscode-extension/raw/main/doc/insert-preview-records.gif)
1830

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.
2032

21-
You need to have a xata account & personal access token. https://xata.io/
33+
---
2234

23-
**Enjoy!**
35+
Made by 🦋

doc/get-started-view.png

63.8 KB
Loading

doc/workspaces-view.png

60 KB
Loading

0 commit comments

Comments
 (0)