From b039fcc815af5cf638833099b6122276706c0821 Mon Sep 17 00:00:00 2001 From: Thiago Esteves Date: Thu, 10 Oct 2024 22:20:15 -0300 Subject: [PATCH] Improved ex_doc information --- CHANGELOG.md | 15 +++++++++++++++ README.md | 2 +- lib/jellyfish/jellyfish.ex | 6 ++++++ mix.exs | 25 +++++++++++++++++++------ 4 files changed, 41 insertions(+), 7 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 lib/jellyfish/jellyfish.ex diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..914c858 --- /dev/null +++ b/CHANGELOG.md @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index ffe64a0..db4c584 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/lib/jellyfish/jellyfish.ex b/lib/jellyfish/jellyfish.ex new file mode 100644 index 0000000..55f3a4a --- /dev/null +++ b/lib/jellyfish/jellyfish.ex @@ -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 diff --git a/mix.exs b/mix.exs index fcd9655..af8f61a 100644 --- a/mix.exs +++ b/mix.exs @@ -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(), @@ -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: %{ @@ -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