Skip to content

Commit

Permalink
Improving documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagoesteves committed Sep 1, 2024
1 parent d4ae4bd commit 151cdd6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ You also need to add the following lines in the mix project

Once the mix release file is generated, it will contain all the appup/release files to execute a hot-upgrade or full deployment.

# Relup file

The library focuses on generating appup files and including them in the mix release package. It doesn't create relup files directly. If for any reason you need to change the order of the modules in the appup output, you can untar the release, do the changes in the appup files and tar it again. The relup file is typically created during a hot upgrade with the [Deployex](https://github.com/thiagoesteves/deployex) application.

# Examples

Explore [Deployex](https://github.com/thiagoesteves/deployex), an Elixir application showcasing Jellyfish's capabilities in deployment with hot-upgrades.
Expand Down

0 comments on commit 151cdd6

Please sign in to comment.