Skip to content

Commit cb3949b

Browse files
authored
chore: update README after initial release
1 parent f0d14dc commit cb3949b

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
<dd align="center"><img alt="React Native Directory Logo" height="96" src="./assets/icon.png" /></dd>
22
<h1 align="center">vscode-react-native-directory</h1>
33

4+
<p align="center">
5+
<a aria-label="Latest release" href="https://github.com/react-native-community/vscode-react-native-directory/releases" target="_blank">
6+
<img alt="Latest release" src="https://img.shields.io/github/package-json/v/react-native-community/vscode-react-native-directory?style=flat-square&color=0366D6&labelColor=49505A" />
7+
</a>
8+
<a aria-label="Workflow status" href="https://github.com/react-native-community/vscode-react-native-directory/actions" target="_blank">
9+
<img alt="Workflow status" src="https://img.shields.io/github/actions/workflow/status/react-native-community/vscode-react-native-directory/verify.yml?branch=main&style=flat-square&labelColor=49505A" />
10+
</a>
11+
<a aria-label="Install from VS Code Marketplace" href="https://marketplace.visualstudio.com/items?itemName=react-native-directory.vscode-react-native-directory" target="_blank">
12+
<img alt="Install from VS Code Marketplace" src="https://img.shields.io/badge/vscode-marketplace-25292E?style=flat-square&label=%20&logoColor=BCC3CD&labelColor=49505A&logo=Visual%20Studio" />
13+
</a>
14+
<a aria-label="Install from Open VSX" href="https://open-vsx.org/extension/react-native-directory/vscode-react-native-directory" target="_blank">
15+
<img alt="Install from Open VSX" src="https://img.shields.io/badge/vscode-open%20vsx-25292E?style=flat-square&label=%20&logoColor=BCC3CD&labelColor=49505A&logo=Eclipse%20IDE" />
16+
</a>
17+
</p>
18+
419
<p align="center">
520
A VS Code extension that allows browsing through the <a href="https://reactnative.directory/">React Native Directory</a><br/>
621
and performing actions related to the chosen package inside the built-in editor Command Palette.
@@ -21,20 +36,17 @@ and performing actions related to the chosen package inside the built-in editor
2136

2237
## 📦 Installation
2338

24-
> [!tip]
25-
> The extension is currently in the development phase, only manual build and installation is supported at this time.
26-
27-
1. Make sure you have [Bun](https://bun.sh/docs/installation) installed.
28-
1. Checkout the repository locally.
29-
1. Run the following commands to install dependencies, compile the source, and prepare the extension package file:
39+
#### VS Marketplace
40+
1. Go to [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=react-native-directory.vscode-react-native-directory).
41+
1. Click on the **"Install"** button.
3042

31-
```sh
32-
bun install && bun compile && bun package
33-
```
43+
#### Open VSX Registry
44+
1. Go to [Open VSX Registry](https://open-vsx.org/extension/react-native-directory/vscode-react-native-directory).
45+
1. Click on the **"Download"** button
3446
1. In VS Code:
3547
* Navigate to the **"Extensions"** pane (<kbd>Ctrl/Cmd+Shift+X</kbd>).
3648
* Click **"More"** button (three dots in the right corner of header) and select **"Install from VSIX"**.
37-
* Select the VSIX file that was created in third step inside the checkout root directory.
49+
* Select the VSIX file downloaded earlier in the process.
3850

3951
## 📝 Contributing
4052

0 commit comments

Comments
 (0)