diff --git a/README.md b/README.md index 0e6e560..a6b9313 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # BlsEx -**TODO: Add description** +This package is Elixir utility to work with BLS signature scheme supporting aggregation of signatures and public keys along with signature and verification. ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `bls_ex` to your list of dependencies in `mix.exs`: +Adds `bls_ex` to your list of dependencies in `mix.exs`: ```elixir def deps do @@ -15,7 +14,6 @@ def deps do 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 . +## Documentation +Documentation is [available on Hexdocs](https://hexdocs.pm/bls_ex) diff --git a/mix.exs b/mix.exs index 83ae5de..950e29b 100644 --- a/mix.exs +++ b/mix.exs @@ -7,7 +7,21 @@ defmodule BlsEx.MixProject do version: "0.1.0", elixir: "~> 1.14", start_permanent: Mix.env() == :prod, - deps: deps() + deps: deps(), + package: package() + ] + end + + defp package do + [ + files: [ + "lib", + "native", + "checksum-*.exs", + "mix.exs", + licenses: ["AGPL-3.0-or-later"], + links: %{"GitHub" => "https://github.com/archethic-foundation/bls_ex"} + ] ] end