Bootstrap Elixir project

Author: LauraBeatris

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.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").
+shin-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/

README.md

@@ -8,11 +8,23 @@
 
 This package aims to provide lightweight utilities that can be used to ensure that primitives are well validated and trusted for usage by auth providers. 
 
-### Roadmap 
+## Roadmap 
 
 This package is currently a work in progress. Those are the features ordered by priority: 
 
 - [ ] OIDC discovery endpoint validator 
 - [ ] SAML response validator
 - [ ] SAML logout request validator 
 - [ ] SAML logout response validator 
+
+## Getting started 
+
+The package can be installed by adding `shin` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:shin, "~> 0.1.0"}
+  ]
+end
+```

lib/shin.ex

@@ -0,0 +1,18 @@
+defmodule Shin do
+  @moduledoc """
+  Documentation for `Shin`.
+  """
+
+  @doc """
+  Hello world.
+
+  ## Examples
+
+      iex> Shin.hello()
+      :world
+
+  """
+  def hello do
+    :world
+  end
+end

mix.exs

@@ -0,0 +1,28 @@
+defmodule Shin.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :shin,
+      version: "0.1.0",
+      elixir: "~> 1.15",
+      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

test/shin_test.exs

@@ -0,0 +1,8 @@
+defmodule ShinTest do
+  use ExUnit.Case
+  doctest Shin
+
+  test "greets the world" do
+    assert Shin.hello() == :world
+  end
+end

test/test_helper.exs

@@ -0,0 +1 @@
+ExUnit.start()