diff --git a/CHANGELOG.md b/CHANGELOG.md index b0bf35c3..0eb94a26 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,9 @@ # Changelog -## v0.3.1 (WIP) +## v0.3.1 (2021-03-05) * Fix `index.js` generation when no hooks are available + * Fix loading hooks from dependencies * Support `` with scheme (#273) ## v0.3.0 (2021-02-24) diff --git a/README.md b/README.md index 0d504636..585e70c4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,34 @@ A VS Code extension that adds support for syntax highlighting is available at ### Example -![Example](images/example.png?raw=true) +```elixir +# Defining the component + +defmodule Hello do + use Surface.Component + + @doc "Someone to say hello to" + prop name, :string, required: true + + def render(assigns) do + ~H""" + Hello, {{ @name }}! + """ + end +end + +# Using the component + +defmodule Example do + use Surface.Component + + def render(assigns) do + ~H""" + + """ + end +end +``` ## How does it work? diff --git a/images/example.png b/images/example.png deleted file mode 100644 index 75596dca..00000000 Binary files a/images/example.png and /dev/null differ diff --git a/mix.exs b/mix.exs index ddf08d29..a38004b4 100644 --- a/mix.exs +++ b/mix.exs @@ -1,7 +1,7 @@ defmodule Surface.MixProject do use Mix.Project - @version "0.3.0" + @version "0.3.1" def project do [