Skip to content

Commit 60f01bb

Browse files
committed
docs: update README to equally support VS Code and Cursor
- Change title to "T-Ruby for VS Code & Cursor" - Reorganize badges with separate sections for each editor - Update installation section with equal treatment for both editors - Fix license text from MIT to BSD 2-Clause
1 parent d059bce commit 60f01bb

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# T-Ruby for Visual Studio Code
1+
# T-Ruby for VS Code & Cursor
22

3-
[![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/t-ruby.t-ruby?label=VS%20Code%20Marketplace)](https://marketplace.visualstudio.com/items?itemName=t-ruby.t-ruby)
4-
[![Open VSX](https://img.shields.io/open-vsx/v/t-ruby/t-ruby?label=Open%20VSX)](https://open-vsx.org/extension/t-ruby/t-ruby)
5-
[![VS Code Installs](https://img.shields.io/visual-studio-marketplace/i/t-ruby.t-ruby)](https://marketplace.visualstudio.com/items?itemName=t-ruby.t-ruby)
6-
[![T-Ruby Compiler](https://img.shields.io/gem/v/t-ruby?label=T-Ruby%20Compiler)](https://rubygems.org/gems/t-ruby)
3+
[![T-Ruby](https://img.shields.io/gem/v/t-ruby?label=T-Ruby)](https://rubygems.org/gems/t-ruby)
74
[![License](https://img.shields.io/github/license/type-ruby/t-ruby-vscode)](LICENSE)
85

9-
T-Ruby language support for Visual Studio Code. Provides syntax highlighting, LSP-based code intelligence, and development tools for [T-Ruby](https://github.com/type-ruby/t-ruby) - a TypeScript-style static type system for Ruby.
6+
**VS Code**
7+
[![Extension](https://img.shields.io/visual-studio-marketplace/v/t-ruby.t-ruby?label=Extension)](https://marketplace.visualstudio.com/items?itemName=t-ruby.t-ruby) [![Downloads](https://img.shields.io/visual-studio-marketplace/i/t-ruby.t-ruby?label=Downloads)](https://marketplace.visualstudio.com/items?itemName=t-ruby.t-ruby)
8+
9+
**Cursor (Open VSX)**
10+
[![Extension](https://img.shields.io/open-vsx/v/t-ruby/t-ruby?label=Extension)](https://open-vsx.org/extension/t-ruby/t-ruby) [![Downloads](https://img.shields.io/open-vsx/dt/t-ruby/t-ruby?label=Downloads)](https://open-vsx.org/extension/t-ruby/t-ruby)
11+
12+
T-Ruby language support for VS Code and Cursor. Provides syntax highlighting, LSP-based code intelligence, and development tools for [T-Ruby](https://github.com/type-ruby/t-ruby) - a TypeScript-style static type system for Ruby.
1013

1114
## Features
1215

@@ -46,15 +49,14 @@ Or install via command line:
4649
code --install-extension t-ruby.t-ruby
4750
```
4851

49-
## Cursor
52+
### Cursor
5053

51-
This extension is also available for [Cursor](https://cursor.com), a fork of VS Code.
54+
Install from the [Open VSX Registry](https://open-vsx.org/extension/t-ruby/t-ruby):
5255

53-
- **Same codebase**: Cursor uses the same extension code as VS Code
54-
- **Different marketplace**: Install from Open VSX Registry instead of VS Code Marketplace
55-
56-
Install for Cursor:
57-
- Open VSX: https://open-vsx.org/extension/t-ruby/t-ruby
56+
1. Open Cursor
57+
2. Go to Extensions (Ctrl+Shift+X)
58+
3. Search for "T-Ruby"
59+
4. Click Install
5860

5961
## Configuration
6062

@@ -65,12 +67,6 @@ Install for Cursor:
6567
| `t-ruby.diagnostics.enable` | `true` | Enable real-time diagnostics |
6668
| `t-ruby.completion.enable` | `true` | Enable autocomplete suggestions |
6769

68-
## Compatibility
69-
70-
| Extension Version | T-Ruby Compiler |
71-
|-------------------|-----------------|
72-
| 0.1.x | >= 0.0.30 |
73-
7470
## Related
7571

7672
- [T-Ruby Compiler](https://github.com/type-ruby/t-ruby) - The main T-Ruby compiler
@@ -79,4 +75,4 @@ Install for Cursor:
7975

8076
## License
8177

82-
MIT
78+
BSD 2-Clause

0 commit comments

Comments
 (0)