Skip to content

Commit 53c42c6

Browse files
docs: Improve documentation
1 parent 1ad29d1 commit 53c42c6

File tree

1 file changed

+8
-30
lines changed

1 file changed

+8
-30
lines changed

README.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -60,46 +60,36 @@ In Observability Mode, Lambda Live Debugger intercepts requests and sends them t
6060

6161
### Installation
6262

63-
Install locally:
63+
Install globally:
6464

6565
```
66-
npm install lambda-live-debugger
66+
npm install lambda-live-debugger -g
6767
```
6868

69-
or globally
69+
_(On Linux and Mac: `sudo npm install lambda-live-debugger -g`)_
70+
71+
or locally
7072

7173
```
7274
npm install lambda-live-debugger -g
7375
```
7476

75-
(On Linux and Mac: `sudo npm install lambda-live-debugger -g`)
77+
_(If installed locally, you must prefix all commands with `npx`, if they are not part of `scripts` in `package.json`.)_
7678

77-
Running the Tool
79+
## Running the Tool
7880

7981
With default profile, region, and other default settings:
8082

8183
```
8284
lld
8385
```
8486

85-
or if installed locally:
86-
87-
```
88-
npx lld
89-
```
90-
91-
But you probably need to tweak some settings. You can do it via CLI parameters or, better, run a wizard:
87+
You probably need to tweak some settings. You can do it via CLI parameters or, better, run the wizard:
9288

9389
```
9490
lld -w
9591
```
9692

97-
or if installed locally:
98-
99-
```
100-
npx lld -w
101-
```
102-
10393
The configuration is saved to `lldebugger.config.ts`
10494

10595
### CLI Parameters
@@ -167,12 +157,6 @@ To remove Lambda Live Debugger from your AWS account
167157
lld -r
168158
```
169159

170-
or if installed locally:
171-
172-
```
173-
npx lld -r
174-
```
175-
176160
This detaches the Layer from your Lambdas and removes the IoT permission policy. It will not remove the Layer as others might use it.
177161

178162
To also remove the Layer:
@@ -181,12 +165,6 @@ To also remove the Layer:
181165
lld -r=all
182166
```
183167

184-
or if installed locally:
185-
186-
```
187-
npx lld -r=all
188-
```
189-
190168
## Framework-Specific Notes
191169

192170
### AWS CDK v2

0 commit comments

Comments
 (0)