Skip to content

Commit c4efec9

Browse files
committed
docs(overmind): update readme and config texts
1 parent 9fd29e9 commit c4efec9

File tree

2 files changed

+24
-48
lines changed

2 files changed

+24
-48
lines changed
Lines changed: 23 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,41 @@
1-
# overmind-devtools README
1+
<h1 align="center">
2+
<br>
3+
<img src="https://github.com/cerebral/overmind/blob/next/logo.png?raw=true" alt="logo" width="100">
4+
<br>
5+
Overmind Devtools for VS Code
6+
<br>
7+
<br>
8+
</h1>
29

3-
This is the README for your extension "overmind-devtools". After writing up a brief description, we recommend including the following sections.
10+
<h4 align="center">Devtools for Overmind - <a href="https://overmindjs.org/">https://overmindjs.org/</a></h4>
411

5-
## Features
6-
7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
12+
## Getting started
813

9-
For example if there is an image subfolder under your extension project workspace:
14+
1. Grab extension from [marketplace](https://marketplace.visualstudio.com/items?itemName=overmind.devtools)
15+
2. Run the command `Overmind Devtools: Start`
1016

11-
\!\[feature X\]\(images/feature-x.png\)
1217

13-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
18+
## Features
1419

15-
## Requirements
20+
- explore state
21+
- etc etc
1622

17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
1823

1924
## Extension Settings
2025

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
2526
This extension contributes the following settings:
2627

27-
* `myExtension.enable`: enable/disable this extension
28-
* `myExtension.thing`: set to `blah` to do something
28+
* `overmind-devtools.port`: port for devtools backend server
29+
* `overmind-devtools.verbose`: toggle verbose logging
2930

3031
## Known Issues
3132

32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
33+
* Relaunch does not work.
34+
* overmind-devtools-client dist files are manually copied into overmind-devtools-vscode
35+
* storage in overmind-devtools-vscode is a dummy, and must be updated to VSCode APIs
36+
* DevtoolsPanel needs a refactor and must implement more VS apis
4137

42-
### 1.0.1
4338

44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
-----------------------------------------------------------------------------------------------------------
51-
52-
## Working with Markdown
53-
54-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
57-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
58-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
59-
60-
### For more information
61-
62-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
39+
## Release Notes
6440

65-
**Enjoy!**
41+
TODO

packages/node_modules/overmind-devtools-vscode/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"properties": {
2222
"overmind-devtools.port": {
2323
"default": 3031,
24-
"description": "The default port for the internal relay server",
24+
"description": "Port for devtools backend server",
2525
"type": "number"
2626
},
2727
"overmind-devtools.verbose": {

0 commit comments

Comments
 (0)