README.md

Finka.js

Handy tool in nowadays JavaScript jungle.

It's extending default JS classes like Array or String with new handy methods, that probably sooner or later you are going to search for on Stack Overflow ;)

What means Finka?

Finka is Polish word and means a knife usually used by scouts. It's also abbreviation to nóż fiński so Finnish knife. According to Wikipedia it's originally really Finnish knife called Puukko.

Bitbar is Finnish company responsible for Bitbar Cloud, which hosts hundreds of Android and iOS devices, enabling users to create and test high quality mobile apps and games. Main R&D team is in Wrocław, Poland.

Getting Started

Prerequisites

This package is using UMD pattern, so it means that you can use it:

• in Node.js project
• browser running project
  • without AMD
  • with AMD

Usage

Install:

npm install @bitbar/finka

And then in you main JS file:

const finka = require('@bitbar/finka');
finka();

Documentation

https://bitbar.github.io/finka-js/

Contribution

Checking code quality

npm run lint

Running tests

npm run test

Building

npm run build

Updating documentation

npm run docs

Authors

• Marek Sierociński - marverix
• tpiechaczek - tpiechaczek
• Bartosz Trzos - Trzosoo
• Alberto Luis Fernandez Reyes - alberto-f
• ToniaR - ToniaR
• Toni - ToniVaakanainen
• gfduszynski - gfduszynski

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details