Skip to content

Commit

Permalink
Rename surface_form to surface_form_helpers and add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
msaraiva committed Sep 24, 2024
1 parent 9f163cb commit 3c24f6e
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ erl_crash.dump
*.ez

# Ignore package tarball (built via "mix hex.build").
surface_form-*.tar
surface_form_helpers-*.tar

# Temporary files, for example, from tests.
/tmp/
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2019 Marlus Saraiva
Copyright (c) 2024 Marlus Saraiva

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Surface.Form

Surface Wrappers for `Phoenix.HTML.Form` functions.
Surface wrappers for legacy `Phoenix.HTML.Form` functions.

> [!NOTE]
> This library is maintained only for compatibility and does not accept new features.
Expand All @@ -12,17 +12,18 @@ Surface Wrappers for `Phoenix.HTML.Form` functions.
## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `surface_form` to your list of dependencies in `mix.exs`:
Add `surface_form_helpers` to the list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:surface_form, "~> 0.1.0"}
{:surface_form_helpers, "~> 0.1.0"}
]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/surface_form>.
## License

Copyright (c) 2024, Marlus Saraiva.

Surface source code is licensed under the [MIT License](LICENSE.md).
6 changes: 3 additions & 3 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ defmodule Surface.Form.MixProject do
use Mix.Project

@version "0.1.0"
@source_url "https://github.com/surface-ui/surface_form"
@source_url "https://github.com/surface-ui/surface_form_helpers"
@homepage_url "https://surface-ui.org"

def project do
[
app: :surface_form,
app: :surface_form_helpers,
version: @version,
elixir: "~> 1.13",
description: "Surface wrappers for Phoenix.HTML.Form functions",
Expand Down Expand Up @@ -97,7 +97,7 @@ defmodule Surface.Form.MixProject do
licenses: ["MIT"],
links: %{
Website: @homepage_url,
Changelog: "https://hexdocs.pm/surface_form/changelog.html",
Changelog: "https://hexdocs.pm/surface_form_helpers/changelog.html",
GitHub: @source_url
},
files: ~w(
Expand Down
4 changes: 2 additions & 2 deletions priv/catalogue/surface/components/catalogue.ex
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ defmodule Surface.Components.Catalogue do
head_css: """
<style>#{@bulma_css}</style>
""",
# Using catalogue JS because surface_form doesn't have any custom JS
# or Hooks. Needs to change if surface_form starts having javascript.
# Using catalogue JS because surface_form_helpers doesn't have any custom JS
# or Hooks. Needs to change if surface_form_helpers starts having javascript.
head_js: """
<script defer type="module" src="/assets/catalogue/app.js"></script>
"""
Expand Down

0 comments on commit 3c24f6e

Please sign in to comment.