@raphy/ngx-equalizer/README.md

A library to equalize height and width of elements with Angular4+

# ngx-equalizer

[![npm](https://img.shields.io/npm/v/ngx-equalizer.svg?style=flat-square)](https://www.npmjs.com/package/ngx-equalizer)
[![Package Quality](http://npm.packagequality.com/shield/ngx-equalizer.svg?style=flat-square)](http://packagequality.com/#?package=ngx-equalizer)
[![Travis](https://img.shields.io/travis/Raphy/ngx-equalizer.svg?style=flat-square)](https://travis-ci.org/Raphy/ngx-equalizer)
[![Coveralls](https://img.shields.io/coveralls/Raphy/ngx-equalizer.svg?style=flat-square)](https://coveralls.io/github/Raphy/ngx-equalizer?branch=master)
[![npm](https://img.shields.io/npm/dm/ngx-equalizer.svg?style=flat-square)](https://www.npmjs.com/package/ngx-equalizer)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/Raphy/ngx-equalizer/blob/master/LICENSE)

> A library to equalize height and width of elements with Angular4+

## Table of contents

 - [Installation](#installation)
 - [Contributing](#contributing)
 - [Changelog](CHANGELOG.md)
 
## Installation
```shell
npm install --save ngx-equalizer
```

Once installed you need to import our main module:
```typescript
import { EqualizerModule } from 'ngx-equalizer';
```

The only remaining part is to list the imported module in your application module.

```typescript
@NgModule({
  declarations: [AppComponent, ...],
  imports: [EqualizerModule.forRoot(), ...],
  bootstrap: [AppComponent]
})
export class AppModule {
}
```

## Contributing

* Before adding any new feature or a fix make sure to open an issue first!

Make sure you have `angular-cli` & `karma` installed globally.

```bash
$ npm install -g angular-cli karma
```

Clone the project, and install dependencies.

```bash
$ git clone https://github.com/raphy/ngx-equalizer.git
$ npm install
```

Create a new branch

```bash
$ git checkout -b feat/someFeature
```

Add tests & make sure everything is running properly
```bash
$ npm test
```

Commit & push, and make a pull request!