Skip to content

Commit 82f507f

Browse files
committed
docs(overmind): updated devtools README
1 parent ba076bf commit 82f507f

File tree

1 file changed

+14
-7
lines changed
  • packages/node_modules/overmind-devtools-vscode

1 file changed

+14
-7
lines changed

packages/node_modules/overmind-devtools-vscode/README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,20 @@
1111

1212
## Getting started
1313

14-
1. Grab extension from [marketplace](https://marketplace.visualstudio.com/items?itemName=overmind.devtools)
15-
2. Run the command `Overmind Devtools: Start`
14+
15+
1. Grab extension from [marketplace](https://marketplace.visualstudio.com/items?itemName=christianalfoni.overmind-devtools-vscode)
16+
1. Run the command `Overmind Devtools: Start`
17+
1. Start your app
18+
19+
### Enabling devtools in your app
20+
Make sure your app has devtools enabled. This is done by passing `devtools: true` to `createOvermind`
21+
```js
22+
const overmind = createOvermind(config, {
23+
devtools: true // defaults to 'localhost:3031'
24+
})
25+
```
26+
27+
If you for some reason can't use port 3031 you can change this via the `overmind-devtools.port` setting.
1628

1729

1830
## Features
@@ -28,11 +40,6 @@ This extension contributes the following settings:
2840
* `overmind-devtools.port`: port for devtools backend server
2941
* `overmind-devtools.verbose`: toggle verbose logging
3042

31-
## Known Issues
32-
33-
* Relaunch does not work.
34-
* DevtoolsPanel needs a refactor and must implement more VS apis
35-
3643
## Release Notes
3744

3845
TODO

0 commit comments

Comments
 (0)