Skip to content

Commit ba8b2f1

Browse files
authored
Task: README improvements (#289)
* Update README.md * Changed video
1 parent 2a4fe4d commit ba8b2f1

1 file changed

Lines changed: 19 additions & 23 deletions

File tree

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# LiveDebugger
1+
![LiveDebugger_Chrome_WebStore](https://github.com/user-attachments/assets/cf9aee3b-58ab-4c45-8a43-d73182cb3e02)
2+
23

34
LiveDebugger is a browser-based tool for debugging applications written in [Phoenix LiveView](https://github.com/phoenixframework/phoenix_live_view) - an Elixir library designed for building rich, interactive online experiences with server-rendered HTML.
45

@@ -8,10 +9,14 @@ Designed to enhance your development experience LiveDebugger gives you:
89
- :mag: The ability to inspect assigns for LiveViews and LiveComponents
910
- :link: Tracing of their callback executions
1011

11-
https://github.com/user-attachments/assets/37f1219c-93cc-4d06-96f7-9b2140a1c971
12+
https://github.com/user-attachments/assets/a09d440c-4217-4597-b30e-f8b911a9094a
13+
14+
## Getting started
15+
> [!IMPORTANT]
16+
> LiveDebugger should not be used on production - make sure that the dependency you've added is `:dev` only
1217
13-
## Installation
1418

19+
### Mix installation
1520
Add `live_debugger` to your list of dependencies in `mix.exs`:
1621

1722
```elixir
@@ -32,19 +37,20 @@ For full experience we recommend adding below line to your application root layo
3237
</head>
3338
```
3439

35-
After you start your application LiveDebugger will be running at a default port `http://localhost:4007`.
40+
After you start your application, LiveDebugger will be running at a default port `http://localhost:4007`.
3641

37-
> [!WARNING]
38-
> LiveDebugger should not be used on production! Make sure that the dependency you've added is `:dev` only
42+
### Igniter installation
3943

40-
## Browser features
44+
LiveDebugger has [Igniter](https://github.com/ash-project/igniter) support - an alternative for standard mix installation. It'll automatically add LiveDebugger dependency and modify your `root.html.heex` after you use the below command.
4145

42-
List of browser features:
46+
```bash
47+
mix igniter.install live_debugger
48+
```
4349

44-
- Debug button
45-
- Components highlighting (coming soon!)
4650

47-
Some features require injecting JS into the debugged application. You can disable them in your config.
51+
## Optional configuration
52+
### Browser features
53+
Some features require injecting JS into the debugged application. They are enabled by default, but you can disable them in your config.
4854

4955
```elixir
5056
# config/dev.exs
@@ -68,25 +74,15 @@ In `router.ex` of your Phoenix app, make sure your locally running Phoenix app c
6874
plug :put_secure_browser_headers, %{"content-security-policy" => @csp}
6975
```
7076

71-
## Igniter
72-
73-
LiveDebugger has [Igniter](https://github.com/ash-project/igniter) support - an alternative for standard mix installation. It'll automatically add LiveDebugger dependency and modify your `root.html.heex` after you use the below command.
74-
75-
```bash
76-
mix igniter.install live_debugger
77-
```
78-
79-
Make sure that added dependency is `:dev` only.
80-
81-
## Optional configuration
77+
### Other
8278

8379
```elixir
8480
# config/dev.exs
8581

8682
config :live_debugger,
8783
ip: {127, 0, 0, 1}, # IP on which LiveDebugger will be hosted
8884
port: 4007, # Port on which LiveDebugger will be hosted
89-
secret_key_base: <SECRET_KEY_BASE>, # Secret key used for LiveDebugger.Endpoint
85+
secret_key_base: "YOUR_SECRET_KEY_BASE", # Secret key used for LiveDebugger.Endpoint
9086
signing_salt: "your_signing_salt", # Signing salt used for LiveDebugger.Endpoint
9187
adapter: Bandit.PhoenixAdapter # Adapter used in LiveDebugger.Endpoint
9288
tracing_setup_delay: 0 # Time in ms after tracing will be initialized. Useful in case multi-nodes envs

0 commit comments

Comments
 (0)