Skip to content

Enhancement: Added badges to readme #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kraleppa merged 3 commits into from
Apr 28, 2025
Merged

Enhancement: Added badges to readme #327

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
574ffa2
Format
kraleppa Apr 28, 2025
0ad991c
Update README.md
kraleppa Apr 28, 2025
bd502be
Update README.md
kraleppa Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
![LiveDebugger_Chrome_WebStore](https://github.com/user-attachments/assets/cf9aee3b-58ab-4c45-8a43-d73182cb3e02)

<div align="center">

[![Version Badge](https://img.shields.io/badge/version-v0.1.6-%23b5e1f1)](https://hexdocs.pm/live_debugger)
[![Hex.pm Downloads](https://img.shields.io/hexpm/dw/live_debugger?style=flat&label=downloads&color=%23b5e1f1)](https://hex.pm/packages/live_debugger)
[![GitHub License](https://img.shields.io/github/license/software-mansion/live-debugger?color=%23b5e1f1)](https://github.com/software-mansion/live-debugger/blob/main/LICENSE)

</div>


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.

Expand All @@ -12,11 +20,12 @@ Designed to enhance your development experience LiveDebugger gives you:
https://github.com/user-attachments/assets/a09d440c-4217-4597-b30e-f8b911a9094a

## Getting started

> [!IMPORTANT]
> LiveDebugger should not be used on production - make sure that the dependency you've added is `:dev` only


### Mix installation

Add `live_debugger` to your list of dependencies in `mix.exs`:

```elixir
Expand Down Expand Up @@ -47,9 +56,10 @@ LiveDebugger has [Igniter](https://github.com/ash-project/igniter) support - an
mix igniter.install live_debugger
```


## Optional configuration

### Browser features

Some features require injecting JS into the debugged application. They are enabled by default, but you can disable them in your config.

```elixir
Expand Down