-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Marek Sierociński
committed
Aug 10, 2018
0 parents
commit 73f2e73
Showing
25 changed files
with
2,522 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Common | ||
node_modules/ | ||
package-lock.json | ||
|
||
# IDE | ||
.vscode/ | ||
.idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
test/ | ||
src/ | ||
rollup.config.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Contributing | ||
|
||
TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
] | ||
} |
Oops, something went wrong.