Skip to content

Commit

Permalink
chore: Documentation for transform command (#40)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Jeffery <[email protected]>
  • Loading branch information
d-jeffery and d-jeffery committed Aug 2, 2023
1 parent 453c0e8 commit 49d9aad
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ OpenFGA is designed to make it easy for application builders to model their perm

## Usage

The extension currently offers 2 core features, with more to come.
The extension currently offers 3 core features, with more to come.

- Syntax Highlighting for OpenFGA files
- A unique theme for OpenFGA for VS Code
Expand All @@ -41,6 +41,15 @@ The extension currently offers 2 core features, with more to come.

![Prompt to set OpenFGA Dark color scheme](resources/set-color-scheme.png)

- A command to transform `OpenFGA` files to `JSON`
- Open an `OpenFGA` file in the editor
- Open the `Command Pallette` using Ctrl+Shift+P (Windows) or Command+Shift+P (OSX)
- Select `OpenFGA: Transform DSL to JSON`
- A new tab will open with the transformed code

![Prompt to execute OpenFGA: Transform DSL to JSON command](resources/transform-command-select.png)



## Development

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"version": "1.0.0",
"repository": {
"type": "git",
"url": "https://github.com:openfga/openfga-vscode"
"url": "https://github.com/openfga/openfga-vscode"
},
"bugs": {
"url": "https://github.com/openfga/openfga-vscode/issues"
Expand Down
Binary file added resources/transform-command-select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 49d9aad

Please sign in to comment.