Skip to content

Commit bcafdcd

Browse files
authored
Fixed pieces of formatting, spelling and typos in README.md (#72)
1 parent e54018f commit bcafdcd

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

.changeset/tender-queens-judge.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"effect-vscode": patch
3+
---
4+
5+
Fixed pieces of formatting, spelling, and typos in README.md

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Effect Dev Tools
22

3-
View traces, metrics and inspect the context for your Effect app - all without leaving VSCode!
3+
View traces, metrics, and inspect the context for your Effect app - all without leaving VS Code!
44

55
## Setup
66

7-
To use Effect Dev Tools in your Effect project, first you need to install the following dependency:
7+
To use Effect Dev Tools in your Effect project, first, you need to install the following dependency:
88

99
```
1010
pnpm install @effect/experimental
@@ -27,20 +27,21 @@ const DevToolsLive = DevTools.layer()
2727
program.pipe(Effect.provide(DevToolsLive), NodeRuntime.runMain)
2828
```
2929

30-
The code above expects the DevTools server to be available at `localhost:34437`. If you are not running the DevTools client (e. g. backend) on the same machine, or if it's not available at localhost, you'll have to manully specify the websocket server url like so:
30+
The code above expects the `DevTools` server to be available at `localhost:34437`. If you are not running the `DevTools` client (e.g., backend) on the same machine, or if it's not available at `localhost`, you'll have to manually specify the websocket server URL like so:
31+
3132
```ts
3233
const DevToolsLive = DevTools.layer('ws://localhost:34437')
3334
```
3435

3536
If you are using `@effect/opentelemetry` in your project, then it is important that you provide the `DevTools` layer **before** your tracing layers, so the tracer is patched correctly.
3637

37-
Beware, that Effect DevTools extension does not behave like typical debugger UI, which connects to debugger port of target process. It's the other way around here. One of the reasons for that is to enable tracing of web applications, which are not able to expose ports, as servers do.
38+
Beware that the Effect DevTools extension does not behave like a typical debugger UI, which connects to the debugger port of the target process. It's the other way around here. One of the reasons for that is to enable tracing of web applications, which are not able to expose ports, as servers do.
3839

3940
### Docker
4041

41-
In case you're using docker for local development and want to connect from your containerized application to DevTools server in VS Code, you'll have to do 2 things.
42+
In case you're using Docker for local development and want to connect from your containerized application to the DevTools server in VS Code, you'll have to do 2 things.
4243

43-
1. You'll have to make your host machine addressable from within the container, by adding extra host.
44+
1. You'll have to make your host machine addressable from within the container by adding an extra host.
4445

4546
```yaml
4647
services:
@@ -49,14 +50,14 @@ services:
4950
- host.docker.internal:host-gateway
5051
```
5152
52-
2. You'll have to specify connection URL in your application to be
53+
2. You'll have to specify the connection URL in your application to be
5354
5455
```ts
5556
DevTools.layer('ws://host.docker.internal:34437');
5657
```
5758

5859
## Usage
5960

60-
Once you have added the Layer to your project, open the Effect Dev Tools panel in vscode & click "Start the server" in the "Clients" panel.
61+
Once you have added the Layer to your project, open the Effect Dev Tools panel in VS Code & click "Start the server" in the "Clients" panel.
6162

6263
You can then start your Effect app, and then begin to inspect the results!

0 commit comments

Comments
 (0)