Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 2.24 KB

README.md

File metadata and controls

102 lines (74 loc) · 2.24 KB

sort

Elixir Build Status Dart Build Status codecov.io Hex.pm pub package contributions welcome HitCount

Why?

We needed a way to manage the sort (order) in our App both on the server (Elixir) and mobile (Flutter) client. So we wrote this mini package that works in both languages.

What?

sort.json is a maintainable list of sort objects/maps that anyone can read to be informed of sort used in our App(s). It makes it easier for us to keep them 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?

Elixir

Installation

Add sort to your dependencies in mix.exs:

def deps do
  [
    {:sort, "~> 1.0.0"},
  ]
end

Usage

sort = Sort.get_list()
# use them how you see fit

Documentation available at: hexdocs.pm/sort

Dart

Installation

You can run the following command to install the dependency.

flutter pub add srt

Alternatively, add srt to your dependencies in pubspec.yml:

dependencies:
  srt: ^1.0.0

Usage

final sortArray = Sort.get()
# use them how you see fit

Documentation available at: pub.dev/packages/sort