Commit c3153af4 authored by Antonin Dupont's avatar Antonin Dupont 💬
Browse files

Fix + enhance documentation

parent 7cc9cd2d
......@@ -19,10 +19,10 @@ Just an import.
In your elixir script:
``` elixir
Mix.install([:gva])
Mix.install([:global_variable])
import GVA
```
## Notes
- Elixir `1.12` is needed (`Kernel.then/1` and `Mix.install/1`)
- Elixir `1.12` is needed (`then/1` and `Mix.install/1`)
......@@ -5,7 +5,7 @@ defmodule GVA do
All commands are prefixed with the letter `g` to prevent any clash with future `Kernel` functions.
To use it in your script be sure to run at least Elixir `1.12` then import functions like the following:
Mix.install([:gva])
Mix.install([:global_variable])
import GVA
An ETS table is used underneath meaning you can use any funky tricks to manipulate it data, pattern match and so on.
......@@ -14,7 +14,7 @@ defmodule GVA do
## Examples
Mix.install([:gva])
Mix.install([:global_variable])
import GVA
gnew :var
......
......@@ -4,13 +4,14 @@ defmodule GVA.MixProject do
def project do
[
app: :global_variable,
version: "0.1.0",
version: "0.1.1",
elixir: "~> 1.12",
start_permanent: Mix.env() == :prod,
deps: deps(),
package: package(),
description: description(),
source_url: "https://gitlab.com/locahlost/gva"
source_url: "https://gitlab.com/locahlost/gva",
docs: docs()
]
end
......@@ -26,15 +27,22 @@ defmodule GVA.MixProject do
]
end
defp description() do
defp description do
"Bring global variable in your Elixir scripts."
end
defp package() do
defp package do
[
name: "global_variable",
licenses: ["Do What The Fuck You Want To Public License"],
links: %{"GitLab" => "https://gitlab.com/locahlost/gva"}
]
end
defp docs() do
[
main: "readme",
extras: ["README.md"]
]
end
end
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment