e-structures/README.md

Extended data structures library for JavaScript

# e-structures  [![Build Status](https://travis-ci.org/toystars/eStructures.svg?branch=master)](https://travis-ci.org/toystars/eStructures) [![Coverage Status](https://coveralls.io/repos/github/toystars/eStructures/badge.svg)](https://coveralls.io/github/toystars/eStructures) [![npm](https://img.shields.io/npm/v/e-structures.svg)](https://www.npmjs.com/package/e-structures) [![Downloads](https://img.shields.io/npm/dt/e-structures.svg)](https://www.npmjs.com/package/e-structures) [![Licence](https://img.shields.io/npm/l/e-structures.svg)](https://www.npmjs.com/package/e-structures) 

Extended data structures for JavaScript.

## Available data structures

* [List](https://github.com/toystars/eStructures/wiki/eList)
* [Map](https://github.com/toystars/eStructures/wiki/eMap)
* [Queue](https://github.com/toystars/eStructures/wiki/eQueue)
* [Stack](https://github.com/toystars/eStructures/wiki/eStack)
* [Priority Queue](https://github.com/toystars/eStructures/wiki/ePriorityQueue)
* [Linked List](https://github.com/toystars/eStructures/wiki/eLinkedList)
* [Set](https://github.com/toystars/eStructures/wiki/eSet)



## How to use
Install via npm
```bash
$ npm install e-structures
```
Install via bower
```bash
$ bower install e-structures
```

## Simple usage
```javascript

// for node
var eStruct = require('e-structures');
var list = new eStruct.eList();

// for browser, after pointing to the dist/eStructures.min.js file, all data structures are available globally
var list = new eList();
```


## Documentation
See the [Wiki](https://github.com/toystars/eStructures/wiki) for documentation.

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/toystars/eStructures).

### Setting up environment

Clone the repository and `cd` to project directory

Install all npm dependencies

```bash
$ npm install
```

Run gulp to watch on file changes (Including test files)
```bash
$ gulp
```


### Pull Requests

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.


### Running Tests

``` bash
$ gulp test
```

## Issues

Check issues for current issues.

## Credits

- [Mustapha Babatunde](https://twitter.com/iAmToystars)
- [Toni Solarin-Sodara](https://twitter.com/tonerdo)
- [Oyebanji Jacob Mayowa](https://twitter.com/py_jac)

## License

The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.