Skip to content

Commit

Permalink
First version
Browse files Browse the repository at this point in the history
  • Loading branch information
Marek Sierociński committed Aug 10, 2018
0 parents commit 73f2e73
Show file tree
Hide file tree
Showing 25 changed files with 2,522 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Common
node_modules/
package-lock.json

# IDE
.vscode/
.idea/
3 changes: 3 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
test/
src/
rollup.config.js
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing

TODO
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 Bitbar Technologies

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Finka.js

Finks.js

## Getting Started

### Prerequisites

This package is using [UMD](https://github.com/umdjs/umd/blob/master/templates/returnExportsGlobal.js) pattern, so it means that you can use it:

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

### Installation

#### Option A: With `npm`

```sh
npm install finka-js
```

#### Option B: Download

Download version that fits your better:

[Compressed version - 1.44KB](https://raw.githubusercontent.com/bitbar/finka-js/master/dist/kasza.min.js)

[Uncompressed version - 2.41KB](https://raw.githubusercontent.com/bitbar/finka-js/master/dist/kasza.js)

And simply add HTML tag:

```html
<script type="text/javascript" src="finka.min.js"></script>
```


### Documentation

TODO


## Authors

* **Marek Sierociński** - [marverix](https://github.com/marverix)
* **tpiechaczek** - [tpiechaczek](https://github.com/tpiechaczek)
* **Bartosz Trzos** - [Trzosoo](https://github.com/Trzosoo)
* **Alberto Luis Fernandez Reyes** - [alberto-f](https://github.com/alberto-f)
* **ToniaR** - [ToniaR](https://github.com/ToniaR)
* **Toni** - [ToniVaakanainen](https://github.com/ToniVaakanainen)
* **gfduszynski** - [gfduszynski](https://github.com/gfduszynski)

See also the list of [contributors](https://github.com/bitbar/finka-js/contributors) who participated in this project.


## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
34 changes: 34 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"name": "finka-js",
"description": "Finka.js",
"main": "dist/finka.min.js",
"authors": [
"Marek Sierociński (https://github.com/marverix)",
"tpiechaczek (https://github.com/tpiechaczek)",
"Bartosz Trzos (https://github.com/Trzosoo)",
"Alberto Luis Fernandez Reyes (https://github.com/alberto-f)",
"ToniaR (https://github.com/ToniaR)",
"Toni (https://github.com/ToniVaakanainen)",
"gfduszynski (https://github.com/gfduszynski)"
],
"license": "MIT",
"keywords": [
"library",
"helper",
"tool",
"util",
"js",
"javascript",
"finka",
"finka-js"
],
"homepage": "https://github.com/bitbar/finka-js",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"src",
"test",
"tests"
]
}
Loading

0 comments on commit 73f2e73

Please sign in to comment.