diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..45e8aa0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog for MishkaInstaller 0.1.0 + +> Kindly ensure that the MishkaInstaller Library is updated as quickly as feasible. This version includes rewriting whole project. It should be noted we do not support previous versions. + +You will see that this version of the project has undergone a total overhaul, and the strategy that was taken to it has been radically altered. + +Because of this, it is not possible to write down the details, and each area has its own document that you are able to study thoroughly. diff --git a/lib/mishka_installer.ex b/lib/mishka_installer.ex index cb5e6f2..3c6dd50 100644 --- a/lib/mishka_installer.ex +++ b/lib/mishka_installer.ex @@ -21,8 +21,8 @@ defmodule MishkaInstaller do ##### This library is divided into the following main sections: - - [Events and Hook](#events-and-hook) - - [Plugin management system theory and installation of Elixir libraries at runtime](#plugin-management-system-theory-and-installation-of-elixir-libraries-at-runtime) + - [Events and Hook](#module-events-and-hook) + - [Plugin management system theory and installation of Elixir libraries at runtime](#module-plugin-management-system-theory-and-installation-of-elixir-libraries-at-runtime) ### Events and Hook diff --git a/mix.exs b/mix.exs index fa5c8f2..9617022 100644 --- a/mix.exs +++ b/mix.exs @@ -1,7 +1,7 @@ defmodule MishkaInstaller.MixProject do use Mix.Project - @version "0.1.0-alpha.2" + @version "0.1.0" @source_url "https://github.com/mishka-group/mishka_installer" def project do @@ -17,12 +17,7 @@ defmodule MishkaInstaller.MixProject do package: package(), homepage_url: "https://github.com/mishka-group", source_url: @source_url, - docs: [ - main: "MishkaInstaller", - source_ref: "master", - extras: ["README.md"], - source_url: @source_url - ], + docs: docs(), test_coverage: [ ignore_modules: [ MishkaInstaller.MnesiaRepo.State, @@ -52,6 +47,7 @@ defmodule MishkaInstaller.MixProject do # Extra tools {:mishka_developer_tools, "~> 0.1.7"}, + # We will cover telemetry in whole project {:telemetry, "~> 1.2.1"}, # Dev and Test dependencies @@ -69,10 +65,25 @@ defmodule MishkaInstaller.MixProject do defp package() do [ - files: ~w(lib .formatter.exs mix.exs LICENSE README*), + files: ~w(lib .formatter.exs mix.exs LICENSE README* Changelog.md), licenses: ["Apache-2.0"], maintainers: ["Shahryar Tavakkoli"], - links: %{"GitHub" => @source_url} + links: %{ + "GitHub" => @source_url, + "Changelog" => "https://hexdocs.pm/mishka_installer/changelog.html" + } + ] + end + + defp docs() do + [ + main: "readme", + source_ref: "v#{@version}", + extras: [ + "README.md", + "CHANGELOG.md" + ], + source_url: @source_url ] end end