Skip to content

Commit 002ab49

Browse files
committed
Update README.md to include platform support details, specifying that Windows is not supported in the current version and outlining future plans for support.
1 parent 9a172a7 commit 002ab49

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

vscode-rescriptdep/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ A Visual Studio Code extension for visualizing dependencies between ReScript mod
99
- **Interactive Graph**: Click on modules to navigate through dependencies
1010
- **High Performance**: Uses digest-based caching to improve performance for large projects
1111

12+
## Platform Support
13+
14+
Currently, this extension is supported on:
15+
- macOS
16+
- Linux
17+
18+
**Important: Windows is not supported in the current version.**
19+
20+
Windows support is planned for a future release. The limitation is due to issues with the CLI binary build process.
21+
1222
## Commands
1323

1424
This extension provides several commands in the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`):
@@ -33,6 +43,7 @@ The extension uses a caching mechanism to improve performance when analyzing mod
3343

3444
- A ReScript project (with either `bsconfig.json` or `rescript.json` configuration file)
3545
- Compiled output in the `lib/bs` directory
46+
- **Platform**: macOS or Linux (Windows is not supported in the current version)
3647

3748
## Installation
3849

@@ -52,6 +63,7 @@ This extension doesn't require any specific settings.
5263

5364
## Known Issues
5465

66+
- Windows platform is not supported in the current version
5567
- Please report any issues on the GitHub repository
5668

5769
## Release Notes

0 commit comments

Comments
 (0)