Skip to content

Commit

Permalink
Simplify installation steps (#448)
Browse files Browse the repository at this point in the history
  • Loading branch information
lbellomo authored Sep 10, 2024
1 parent f7d9d1d commit 5b44b01
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The dashboard also works across nodes. If your nodes are connected via Distribut

## Installation

To start using LiveDashboard, you will need three steps:
The LiveDashboard is built on top of LiveView. Both LiveView and LiveDashboard ship by default as part of Phoenix. But if you skipped them, you can LiveDashboard in three steps:

1. Add the `phoenix_live_dashboard` dependency
2. Configure LiveView
Expand All @@ -54,12 +54,7 @@ end

### 2. Configure LiveView

The LiveDashboard is built on top of LiveView. If LiveView is already installed in your app, feel free to skip this section.

If you plan to use LiveView in your application in the future, we recommend you to follow [the official installation instructions](https://hexdocs.pm/phoenix_live_view/installation.html).
This guide only covers the minimum steps necessary for the LiveDashboard itself to run.

First, update your endpoint's configuration to include a signing salt. You can generate a signing salt by running `mix phx.gen.secret 32` (note Phoenix v1.5+ apps already have this configuration):
First, update your endpoint's configuration to include a signing salt:

```elixir
# config/config.exs
Expand Down

0 comments on commit 5b44b01

Please sign in to comment.