SimonLab / statuses

πŸ“ A collection of statuses for use in our various apps.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

statuses

GitHub Workflow Status codecov.io Hex.pm contributions welcome HitCount

Why?

We found ourselves repating statuses in various projects. e.g: auth/init/statuses.ex
So we decided to "DRY" it and make this single-feature micro-package we can reuse.

What?

statuses.json is a maintainable JSON file that anyone can read to be informed of statuses used in our App(s). It makes it easier for us to keep statuses in one place and means anyone can contribute.

Who?

This package is for us by us. We don't expect anyone else to use it. It's Open Source so that anyone using our Apps can view and contribute to the list.

How?

Installation

Add statuses to your dependencies in mix.exs:

def deps do
  [
    {:statuses, "~> 1.0.1"},
  ]
end

Usage

statuses = Statuses.parse_json()
# use them how you see fit

Todo

Add link to where this is used in MVP.

Documentation available at: hexdocs.pm/statuses

About

πŸ“ A collection of statuses for use in our various apps.

License:GNU General Public License v2.0


Languages

Language:Elixir 100.0%