diff options
| -rw-r--r-- | .formatter.exs | 4 | ||||
| -rw-r--r-- | .gitignore | 26 | ||||
| -rw-r--r-- | README.md | 21 | ||||
| -rw-r--r-- | lib/mystic.ex | 18 | ||||
| -rw-r--r-- | mix.exs | 28 | ||||
| -rw-r--r-- | test/mystic_test.exs | 8 | ||||
| -rw-r--r-- | test/test_helper.exs | 1 |
7 files changed, 106 insertions, 0 deletions
diff --git a/.formatter.exs b/.formatter.exs new file mode 100644 index 0000000..d2cda26 --- /dev/null +++ b/.formatter.exs @@ -0,0 +1,4 @@ +# Used by "mix format" +[ + inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] +] diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0b30486 --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# The directory Mix will write compiled artifacts to. +/_build/ + +# If you run "mix test --cover", coverage assets end up here. +/cover/ + +# The directory Mix downloads your dependencies sources to. +/deps/ + +# Where third-party dependencies like ExDoc output generated docs. +/doc/ + +# Ignore .fetch files in case you like to edit your project deps locally. +/.fetch + +# If the VM crashes, it generates a dump, let's ignore it too. +erl_crash.dump + +# Also ignore archive artifacts (built via "mix archive.build"). +*.ez + +# Ignore package tarball (built via "mix hex.build"). +mystic-*.tar + +# Temporary files, for example, from tests. +/tmp/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..f7de57e --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Mystic + +**TODO: Add description** + +## Installation + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed +by adding `mystic` to your list of dependencies in `mix.exs`: + +```elixir +def deps do + [ + {:mystic, "~> 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/mystic>. + diff --git a/lib/mystic.ex b/lib/mystic.ex new file mode 100644 index 0000000..1abf785 --- /dev/null +++ b/lib/mystic.ex @@ -0,0 +1,18 @@ +defmodule Mystic do + @moduledoc """ + Documentation for `Mystic`. + """ + + @doc """ + Hello world. + + ## Examples + + iex> Mystic.hello() + :world + + """ + def hello do + :world + end +end @@ -0,0 +1,28 @@ +defmodule Mystic.MixProject do + use Mix.Project + + def project do + [ + app: :mystic, + version: "0.1.0", + elixir: "~> 1.17", + start_permanent: Mix.env() == :prod, + deps: deps() + ] + end + + # Run "mix help compile.app" to learn about applications. + def application do + [ + extra_applications: [:logger] + ] + end + + # Run "mix help deps" to learn about dependencies. + defp deps do + [ + # {:dep_from_hexpm, "~> 0.3.0"}, + # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"} + ] + end +end diff --git a/test/mystic_test.exs b/test/mystic_test.exs new file mode 100644 index 0000000..4344354 --- /dev/null +++ b/test/mystic_test.exs @@ -0,0 +1,8 @@ +defmodule MysticTest do + use ExUnit.Case + doctest Mystic + + test "greets the world" do + assert Mystic.hello() == :world + end +end diff --git a/test/test_helper.exs b/test/test_helper.exs new file mode 100644 index 0000000..869559e --- /dev/null +++ b/test/test_helper.exs @@ -0,0 +1 @@ +ExUnit.start() |