Skip to content

Commit

Permalink
Change umbrella-specific instructions (#47)
Browse files Browse the repository at this point in the history
* Change umbrella-specific instructions

Also removes the mix task because it is not needed/used any more (with
this change)

* avoid pronouns
  • Loading branch information
axelson committed Jan 29, 2022
1 parent 6527dd3 commit 258c61e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 35 deletions.
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.

0 comments on commit 258c61e

Please sign in to comment.