# Hybrid JS Utils

 [![NPM version][npm-version-image]][npm-url]
 [![Build Status][travis-image]][travis-url]
 [![Coverage Status][test-coverage-image]][test-coverage-url] ![PRs welcome][contributing-image]
 [![Size](https://img.shields.io/bundlephobia/min/hybrid-js-utils)](https://img.shields.io/bundlephobia/minzip/hybrid-js-utils)

A simple set of commonly used Javascript functions

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

Actually none.

### Installing

You can install hybrid-js-utils by simply downloading the js file,
or if you have node installed you can use the following command

```
$ path-to-project/ npm install hybrid-js-utils
```

## Running the tests

You can check some functionalities by opening the ./test/index.html in your browser

## Contributing

* Step 1. Clone this repo
* Step 2. Run `npm i` in the download path
* Step 3. You can edit this library by edinting files under `src/`
* Step 4. You can edit/add tests under `test/hybrid-js-utils.test.ts` (do not edit index and js)
* Step 4. Run `npm run test`
* Step 5. If test *PASSES* you can make a pull request, otherwise, go back to step 3 and repeat.

## Special thanks

Jetbrains is now supporting this library with an open-source licence, which will allow a better code! 🎉

![jetbrains-logo](https://user-images.githubusercontent.com/5957244/150580991-863d6fba-1090-4924-b26c-be19c6310f24.svg)

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 

## Authors

* *Initial work and devs* - [TonySamperi](https://github.com/TonySamperi)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

[npm-url]: https://npmjs.org/package/hybrid-js-utils
[npm-version-image]: https://badge.fury.io/js/hybrid-js-utils.svg
[doc-url]: https://tonysamperi.github.io/js-utils/
[doc-coverage-image]: https://moment.github.io/luxon/docs/badge.svg
[test-coverage-url]: https://codecov.io/gh/tonysamperi/js-utils
[test-coverage-image]: https://codecov.io/gh/tonysamperi/js-utils/branch/master/graph/badge.svg
[contributing-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[travis-image]: https://travis-ci.org/tonysamperi/js-utils.svg?branch=master
[travis-url]: https://travis-ci.org/tonysamperi/js-utils.svg?branch=master