From 80d684dda38ac62e2818a6f519febfda2088488f Mon Sep 17 00:00:00 2001 From: Tiago Moraes Date: Sat, 14 Sep 2024 13:40:09 -0300 Subject: [PATCH] Improve mix.exs, docs and hex page --- assets/surface-logo.png | Bin 0 -> 2064 bytes mix.exs | 35 +++++++++++++++++++++++++++-------- 2 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 assets/surface-logo.png diff --git a/assets/surface-logo.png b/assets/surface-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..7b7d9957e5204261df59d5a11f72371d8a37bca3 GIT binary patch literal 2064 zcmV+r2=DiaP)f;{^=-ZpJj`rXxhHU`v?MTz+lMSf1`fj%BK~^cBOhz6NuR; zUmLqgUP?m+uLD33o)3nBNqg<&o0|I4Z=ByJ@3~aLlVrd1%n@v34|O#I7fTNt+7x$Q zXaelG48FLa>?kUdZU+Pi7l7$eZC7u7$reNVg}bh{@Z_!QlXlg%yM2Vg3iOMt>eZk-_{hs&;69{4Ok<`5npZh9)dUQ}}P$}KVwi7raY1GO`7isz8IhV-3ILD0s*4X1`4G;5#9yENJx7%8b=b_~&c#DJ#_zXj@oXW?u;4Y@ zsy>k9A3qmFV~Bm_w1XMFCMP(QqaW?QtirS7&VksC@=S65@fJWl4>1QY7`^&#=u!gl zOEL~z|B}WP7A!=#3nn`%i&Bj3${tsP+fqnH1(cQf$IkjJ9_E_COk_eOS?frOw}URp zKmHkwD|Bmcw*A4l$oaQyz-YPV>%md z0_)}9oS?Ay8~h=sM zfDswbUH;m^I!{LgPoS{E(k=S#3zNgQ4MaZX-exTZ*lnI9$ET$k523te$-`~Rk7q0o zX27{S!&37$E@xg`YZ`L(p z7&ho{3^XqFrTOQ%1gPBTB_VW9lD~wmps@JKse8U_joB#wF`nIKd4O5X`dj|;)0QrC zoMh(`;KXId+OL2965;{@DwQipBr;n~gHK3shqL1{LcwVW1-x1?J*vGic=hCIB0F1@ zNh&6dC!G8KX#xn)$&k4LL%MF2zp~kC);-2Evqc#w0zf!Nd;}kydVoff>?tsqF=?8P zG?xf7t!CXrBDdIFxf~D=_W|F)1;>2=gGrKPc3AW+mBs41_rLb!go?8S5h-~GNJqn9 z8k{aP7BXDZChg^3#s0SpZ3?fop5?C{{3t*R#yB|50X-?Edp8xnh)>vABSR(GZ<2}S z00KIgPr#&U?#D3jxs>4w{(4zCKY8mKBD?)kldz*^Z)A$B7V-0}N`d1XxMCYU}JmT}>g(FiOU6uPY+cWaWX{Yit%{r)}Ig_v{EbF{Ji*A@>FZ zU~Np!+xgD#sHlJ;J*cXu@q}B*aJ#~yf2P%ufJxK*16kte?6>#MKgZEOH?Vxh_ zKPSuU3Ulu>t&Te;Q@A!ldZ2ZX?D}l#X)2>EPY~0C!+v2uVv`l?1`MpNhowS`uHykX z_kcy)F*0S+ohQrBU6oV92npNzLc{~W)I)9Eym)ZEpAKC4^ax-u`yv7d2v2kkr;a+m za4S=6IDDs;#uNO?2QqzURZ&qOR3*MuQ-c6Rd-Jo7>OTAa!G##pmCLIK2BwaxLbp1p+q(Uzzg5@YP`M2NW&$LRJTQ3N|Bu6kkM7+x zx|(oz#lCaze{Iqffas9+!g~P2py%${;-A?p52lEGytX2`GMg`Xg;2SFmPrKD&?-u zs-iQ#IQzU?8e6~kCxy(RVi(Rm$^& zx0L5?BWkNZIs!7Hsi+{BBa)_tr^ 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() ] @@ -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"}, @@ -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/, @@ -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