/list

A List class for JavaScript with a preset library of sorting algorithms. High performance but ridiculously tiny.

Primary LanguageJavaScriptMIT LicenseMIT

A sortable List Class with a library of preset sorting algorithms. High performance but ridiculously tiny.

Target environments

  • IE 6+
  • Latest Stable: Firefox, Chrome, Safari, Opera
  • Node.js & other non-browser environments or browser extensions

Quick start

Four quick start options are available:

  • Download the latest release
  • Clone the repo: git clone https://github.com/rainersu/list.git
  • Install with Bower: bower install sumi-list
  • Install with npm: npm install sumi-list

Build from source

First, you need to have Node.js and Grunt installed.

$ git clone git@github.com:rainersu/list.git
$ npm install -g grunt-cli
$ cd list
$ npm install
$ grunt

It provides compiled JS (sumi-list.*), as well as compiled and minified JS (sumi-list.min.*). JS source maps (sumi-list.*.map) are available for use with certain browsers' developer tools.

Running demos for testing

$ grunt test

Build & running documentation locally

$ grunt help

Sorry, the documentation is currently offered only in the Chinese language. Do you have time to help me with some Chinese - English translations?

How to contact me

Copyright and license

Copyright 2015 Rainer Su (苏昱).

Code and documentation is free to use under the MIT license.