Skip to content

Commit

Permalink
Improved ex_doc information
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagoesteves committed Oct 11, 2024
1 parent 92dbd31 commit b039fcc
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 7 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CHANGELOG (v0.1.4)

## 0.1.4 ()

### Backwards incompatible changes for 0.0.0
* None

### Installer Actions
* None

### Bug fixes
* None

### Enhancements
* Improved documentation
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ by adding `jellyfish` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:jellyfish, "~> 0.1.3"}
{:jellyfish, "~> 0.1.4"}
]
end
```
Expand Down
6 changes: 6 additions & 0 deletions lib/jellyfish/jellyfish.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
defmodule Jellyfish do
@moduledoc """
Jellyfish is a library designed to streamline the management of appup
and release files, enabling hot-upgrades for Elixir applications.
"""
end
25 changes: 19 additions & 6 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
defmodule Jellyfish.MixProject do
use Mix.Project

@version "0.1.4"

def project do
[
app: :jellyfish,
version: "0.1.3",
version: @version,
elixir: "~> 1.16",
name: "Jellyfish",
source_url: "https://github.com/thiagoesteves/jellyfish",
homepage_url: "https://github.com/thiagoesteves/jellyfish",
start_permanent: Mix.env() == :prod,
deps: deps(),
docs: docs(),
Expand All @@ -29,7 +34,15 @@ defmodule Jellyfish.MixProject do

defp package do
[
files: ["lib", "priv", "mix.exs", "README.md", "LICENSE.md", ".formatter.exs"],
files: [
"lib",
"priv",
"mix.exs",
"README.md",
"LICENSE.md",
"CHANGELOG.md",
".formatter.exs"
],
maintainers: ["Thiago Esteves", "Matthew Galvin"],
licenses: ["MIT"],
links: %{
Expand All @@ -42,16 +55,16 @@ defmodule Jellyfish.MixProject do

defp docs do
[
source_url: "https://github.com/thiagoesteves/jellyfish",
homepage_url: "https://github.com/thiagoesteves/jellyfish",
main: "home"
main: "Jellyfish",
source_ref: "v#{@version}",
extras: ["README.md", "LICENSE.md", "CHANGELOG.md"]
]
end

# Run "mix help deps" to learn about dependencies.
defp deps do
[
{:ex_doc, "~> 0.18", only: :dev}
{:ex_doc, "~> 0.34", only: [:dev, :test], runtime: false}
]
end
end

0 comments on commit b039fcc

Please sign in to comment.