Skip to content
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.

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

Change umbrella-specific instructions #47

Merged
merged 2 commits into from
Jan 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 2 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ def deps do
end
```

NOTE: if you have an umbrella application then add ExSync to one the apps in the umbrella.

Optionally add this snippet to your `.iex.exs` (in the root of your project) or your `~/.iex.exs`:
```
if Code.ensure_loaded?(ExSync) && function_exported?(ExSync, :register_group_leader, 0) do
Expand All @@ -36,30 +38,6 @@ This will prevent the ExSync logs from overwriting your IEx prompt.
Alternatively you can always just run `ExSync.register_group_leader()` in your
IEx prompt.

## Usage for umbrella project

1. Create an umbrella project

```bash
mix new my_umbrella_app --umbrella
```

2. Add exsync to your `mix.exs` dependencies:

```elixir
def deps do
[
{:exsync, "~> 0.2", only: :dev},
]
end
```

3. start your umbrella project with `exsync` task

```bash
iex -S mix exsync
```

## Config

All configuration for this library is handled via the application environment.
Expand Down
11 changes: 0 additions & 11 deletions lib/mix/tasks/exsync.ex

This file was deleted.