Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagoesteves committed May 10, 2024
1 parent b7a375d commit d4ae4bd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ by adding `jellyfish` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:jellyfish, "~> 0.1.1"}
{:jellyfish, "~> 0.1.2"}
]
end
```
Expand All @@ -37,12 +37,14 @@ You also need to add the following lines in the mix project
end
```

Once the mix release file is generated, it will contain all the appup/release files to execute a hot-upgrade or full deployment. The application that will be able to consume and execute full deployment or hot-upgrade is coming soon.
Once the mix release file is generated, it will contain all the appup/release files to execute a hot-upgrade or full deployment.

# Examples

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

# References

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/jellyfish>.

# jellyfish
be found at <https://hexdocs.pm/jellyfish>.
4 changes: 2 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ defmodule Jellyfish.MixProject do
def project do
[
app: :jellyfish,
version: "0.1.1",
version: "0.1.2",
elixir: "~> 1.16",
start_permanent: Mix.env() == :prod,
deps: deps(),
Expand Down Expand Up @@ -35,7 +35,7 @@ defmodule Jellyfish.MixProject do
links: %{
Documentation: "https://hexdocs.pm/jellyfish",
Changelog: "https://hexdocs.pm/jellyfish/changelog.html",
GitHub: "https://github.com/bitwalker/jellyfish"
GitHub: "https://github.com/thiagoesteves/jellyfish"
}
]
end
Expand Down

0 comments on commit d4ae4bd

Please sign in to comment.