Skip to content

Commit

Permalink
Improve mix.exs, docs and hex page
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagoefmoraes committed Sep 14, 2024
1 parent 6a21c82 commit 80d684d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 8 deletions.
Binary file added assets/surface-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 27 additions & 8 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@ defmodule Surface.MixProject do
use Mix.Project

@version "0.12.0-dev"
@source_url "https://github.com/surface-ui/surface"
@homepage_url "https://surface-ui.org"

def project do
[
app: :surface,
version: @version,
elixir: "~> 1.13",
description: "A component based library for Phoenix LiveView",
elixirc_paths: elixirc_paths(Mix.env()),
compilers: Mix.compilers(),
start_permanent: Mix.env() == :prod,
elixirc_paths: elixirc_paths(Mix.env()),
deps: deps(),
preferred_cli_env: [docs: :docs],
# Docs
name: "Surface",
source_url: @source_url,
homepage_url: @homepage_url,
docs: docs(),
package: package()
]
Expand All @@ -31,6 +36,11 @@ defmodule Surface.MixProject do
defp elixirc_paths(:test), do: ["lib", "test/support"] ++ catalogues()
defp elixirc_paths(_), do: ["lib"]

defp catalogues do
["priv/catalogue"]
end

# Run "mix help deps" to learn about dependencies.
defp deps do
[
{:phoenix_live_view, "~> 0.19.0 or ~> 0.20.10"},
Expand All @@ -45,8 +55,8 @@ defmodule Surface.MixProject do
defp docs do
[
main: "Surface",
logo: "assets/surface-logo.png",
source_ref: "v#{@version}",
source_url: "https://github.com/surface-ui/surface",
groups_for_modules: [
Components: ~r/Surface.Components/,
Catalogue: ~r/Catalogue/,
Expand Down Expand Up @@ -74,11 +84,20 @@ defmodule Surface.MixProject do
defp package do
%{
licenses: ["MIT"],
links: %{"GitHub" => "https://github.com/surface-ui/surface"}
links: %{
Website: @homepage_url,
Changelog: "https://hexdocs.pm/surface/changelog.html",
GitHub: @source_url
},
files: ~w(
README.md
CHANGELOG.md
LICENSE.md
mix.exs
.formatter.exs
lib
priv/templates/surface.init
)
}
end

defp catalogues do
["priv/catalogue"]
end
end

0 comments on commit 80d684d

Please sign in to comment.