Skip to content

Commit f417f23

Browse files
Update README
1 parent 9aa3644 commit f417f23

4 files changed

Lines changed: 396 additions & 8 deletions

File tree

README.md

Lines changed: 60 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,67 @@
1-
<h1>Runtime Manager and Syntax Highlighting for <a href="https://rayforcedb.com">RayforceDB</a></h1>
1+
<table style="border-collapse:collapse;border:0;">
2+
<tr>
3+
<td style="border:0;padding:0;">
4+
<a href="https://vscode.rayforcedb.com">
5+
<picture>
6+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayforceDB/rayforce-vscode/refs/heads/master/docs/docs/assets/logo_light.svg">
7+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/RayforceDB/rayforce-vscode/refs/heads/master/docs/docs/assets/logo_dark.svg">
8+
<img src="https://raw.githubusercontent.com/RayforceDB/rayforce-vscode/refs/heads/master/docs/docs/assets/logo_dark.svg" width="200">
9+
</picture>
10+
</a>
11+
</td>
12+
<td style="border:0;padding:0;">
13+
<h1>A Complete Development Environment Embedded in VSCode for <a href="https://core.rayforcedb.com"><picture>
14+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RayforceDB/rayforce-vscode/refs/heads/master/docs/docs/assets/official_logo_light_full.svg">
15+
<img src="https://raw.githubusercontent.com/RayforceDB/rayforce-vscode/refs/heads/master/docs/docs/assets/official_logo_full.svg" alt="RayforceDB" height="40" style="vertical-align: bottom;">
16+
</picture></a></h1>
17+
</td>
18+
</tr>
19+
</table>
220

3-
View and connect to running local and remote instances, monitor CPU and memory usage of local instances, send commands via interactive integrated REPL, introspect the environment variables
21+
![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fvscode.rayforcedb.com%2F) [![Version](https://img.shields.io/github/v/release/RayforceDB/rayforce-vscode)](https://github.com/RayforceDB/rayforce-vscode/releases) [![VS Code Marketplace](https://img.shields.io/badge/VS%20Code-Marketplace-blue)](https://marketplace.visualstudio.com/items?itemName=RayforceDB.rayforce-vscode) [![OpenVSX](https://img.shields.io/badge/OpenVSX-Registry-purple)](https://open-vsx.org/extension/RayforceDB/rayforce-vscode) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
422

5-
<img src="assets/demo.png" alt="Demo" width="1080">
23+
A complete development environment for RayforceDB, right inside VS Code. Manage instances, execute commands via REPL, and enjoy full Rayfall language support.
624

7-
<h3>🎨 As a bonus, full syntax highlighting for Rayfall language files (<code>.rfl</code> and <code>.rf</code>)</h3>
25+
Full Documentation: https://vscode.rayforcedb.com/
826

9-
<h2>Installation</h2>
27+
![Demo](assets/demo.png)
1028

11-
<p>Install from the <a href="https://marketplace.visualstudio.com/items?itemName=RayforceDB.rayforce-vscode">VS Code Marketplace</a> or search for <strong>"Rayforce"</strong> in VS Code extensions.</p>
29+
## Features
1230

13-
<h2>License</h2>
31+
### 🖥️ Instance Manager
1432

15-
<p>MIT</p>
33+
View and connect to running local and remote RayforceDB instances. Organize saved connections into folders and subfolders for easy management. Instances are saved persistently, so you don't need to set them up every time.
34+
35+
### 💻 Interactive REPL
36+
37+
Fully integrated REPL panel for executing Rayfall commands. Access environment variables, get autocomplete suggestions, and interact with your RayforceDB instances seamlessly.
38+
39+
### 🔍 Environment Inspector
40+
41+
Introspect environment variables and see what's defined in your connected RayforceDB instance.
42+
43+
### 🎨 Rayfall Language Support
44+
45+
Full language support for the Rayfall programming language:
46+
47+
- **Autocomplete**: Intelligent autocomplete with built-in functions, keywords, and types
48+
- **Syntax Highlighting**: Beautiful syntax highlighting for `.rfl` files
49+
- **File Icons**: Custom icons for Rayfall source files
50+
51+
## Installation
52+
53+
### VS Code Marketplace
54+
55+
The easiest way to install. Search for "Rayforce" in the VS Code extensions panel or click the button below.
56+
57+
[![Install from VS Code Marketplace](https://img.shields.io/badge/VS%20Code-Marketplace-blue)](https://marketplace.visualstudio.com/items?itemName=RayforceDB.rayforce-vscode)
58+
59+
### OpenVSX Registry
60+
61+
For VSCodium, Theia, Gitpod, and other open-source editors compatible with OpenVSX.
62+
63+
[![Install from OpenVSX](https://img.shields.io/badge/OpenVSX-Registry-purple)](https://open-vsx.org/extension/RayforceDB/rayforce-vscode)
64+
65+
---
66+
67+
**Built with ❤️ for high-performance data processing | <a href="https://vscode.rayforcedb.com/content/license.html">MIT Licenced</a> | RayforceDB Team**

assets/demo.png

107 KB
Loading

docs/docs/assets/demo.png

107 KB
Loading

0 commit comments

Comments
 (0)