Skip to content

PR: Update Installation instructions in README.md fixes #23 #24

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

Open
nelsonic wants to merge 1 commit into
base: main
Choose a base branch
from
Open

PR: Update Installation instructions in README.md fixes #23 #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,29 @@ For an introduction to the project, you can watch this talk from ElixirConf EU 2

[![LiveData talk at ElixirConf EU 2022](https://img.youtube.com/vi/I4vVxtrow-E/0.jpg)](https://www.youtube.com/watch?v=I4vVxtrow-E)

## Installation
## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `phoenix_data_view` to your list of dependencies in `mix.exs`:
The package can be installed
by adding `live_data` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:data_view, "~> 0.1.0"}
{:live_data, "~> 0.1.0-alpha1"}
]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/phoenix_data_view](https://hexdocs.pm/phoenix_data_view).
Then run:

```sh
mix deps.get
```

## Docs

Documentation is available at:
[hexdocs.pm/live_data](https://hexdocs.pm/live_data).

Feedback welcome!