diff --git a/README.md b/README.md index 53c35a7..d0f6cb5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # mix github_workflows.generate +[![hex.pm badge](https://img.shields.io/badge/hex.pm-5e3e80)](https://hex.pm/packages/github_workflows_generator) +[![hexdocs.pm badge](https://img.shields.io/badge/hexdocs.pm-5681bf)](https://hexdocs.pm/github_workflows_generator) + ## Installation Add `github_workflows_generator` to your list of dependencies in `mix.exs`: diff --git a/mix.exs b/mix.exs index 196c8dc..aac3320 100644 --- a/mix.exs +++ b/mix.exs @@ -1,6 +1,9 @@ defmodule GithubWorkflowsGenerator.MixProject do use Mix.Project + @repo "https://github.com/optimumBA/github_workflows_generator" + @version "0.1.0" + def project do [ app: :github_workflows_generator, @@ -9,6 +12,8 @@ defmodule GithubWorkflowsGenerator.MixProject do start_permanent: Mix.env() == :prod, aliases: aliases(), deps: deps(), + + # Code checks preferred_cli_env: [ ci: :test, coveralls: :test, @@ -22,13 +27,15 @@ defmodule GithubWorkflowsGenerator.MixProject do plt_add_apps: [:ex_unit, :mix], plt_file: {:no_warn, "priv/plts/dialyzer.plt"} ], + # Docs name: "GithubWorkflowsGenerator", - source_url: "https://github.com/optimumBA/github_workflows_generator", - docs: [ - main: "Mix.Tasks.GithubWorkflows.Generate", - source_ref: "main" - ] + source_url: @repo, + docs: docs(), + + # Hex package + description: "Generate GitHub Actions workflows", + package: package() ] end @@ -39,6 +46,21 @@ defmodule GithubWorkflowsGenerator.MixProject do ] end + defp docs do + [ + main: "Mix.Tasks.GithubWorkflows.Generate", + source_ref: "v#{@version}" + ] + end + + defp package do + [ + licenses: ["MIT"], + links: %{"GitHub" => @repo}, + maintainers: ["Almir Sarajčić"] + ] + end + # Run "mix help deps" to learn about dependencies. defp deps do [