Skip to content

Commit f7af190

Browse files
authored
Update README.md with screenshots
Adding aGIFs of functionality
1 parent fb30b2f commit f7af190

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,22 @@ Pretty simple really, if you open a .resx/.resw file from your workspace, you ha
1010

1111
![2023-06-22_13-55-08](https://github.com/timheuer/resx-editor/assets/4821/8aa91777-27c9-418f-bab4-5acb1ff5ef8f)
1212

13+
### Edit a resource
1314
To edit, simple click in a cell and start typing. This will 'dirty' the file and you'll have to save (doesn't auto-persist).
1415

15-
### Editing note
16+
### Add a new resource
17+
To add a new resource, open the resx file you want to add it to and launch the command pallette (CTRL + SHIFT + P). Choose `ResX: Add new resource` which will launch a flow to ask you for the Key, Value, and Comment (all required) and then add it to the active document.
18+
![add-resource](https://github.com/timheuer/resx-editor/assets/4821/6bac0939-caf9-4997-ba8e-962242e80438)
19+
20+
### Delete a resource
21+
From an open resx file, right-click on the resource you want to delete and choose `Delete resource` from the context menu.
22+
![delete-resource](https://github.com/timheuer/resx-editor/assets/4821/d846e3fd-157d-4573-ab59-1ada335ad746)
23+
24+
### Logging
25+
In the settings you can enable 'verbose' logging which will create an output window category and you can see some details. Helpful for troubleshooting.
26+
![logging](https://github.com/timheuer/resx-editor/assets/4821/868f6ec6-7953-48b9-a3b9-05d5801115fe)
27+
28+
### A note on editing...
1629
Right now this is a bulk edit -- meaning it will re-serialize the data in/out of JSON/RESX format for this editor. Tracking issue [#1](https://github.com/timheuer/resx-editor/issues/1) for improvements here, but as of now 'works on my machine' applies. The serialization also probably will not match your line endings/spacing so a first diff might be more red/green than expected. If that doesn't work, help fix or just probably not use this.
1730

1831
### VS Code Git diff viewing

0 commit comments

Comments
 (0)