diff --git a/README.md b/README.md index 6165592..d205bc4 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -# BasicSignupWhitelist +# BasicSignupAllowlist -**TODO: Add description** +Minimal function to restrict account creation for the first few accounts. Useful for deploying architectural spikes and bootstrapping. + +Why? Phx Auth offers easy account creation, but no UI to manage created accounts, allowing spammers to create accounts. When putting demoes live, you don't necessarily want to create elaborate account management and invite systems first. ## Installation If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `basic_signup_whitelist` to your list of dependencies in `mix.exs`: +by adding `basic_signup_allow` to your list of dependencies in `mix.exs`: ```elixir def deps do [ - {:basic_signup_whitelist, "~> 0.1.0"} + {:basic_signup_allowlist, "~> 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 . +be found at .