Skip to content

Commit fae7c9b

Browse files
committed
Add readme and license
1 parent 0664606 commit fae7c9b

File tree

2 files changed

+94
-0
lines changed

2 files changed

+94
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Nils S.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<a href="https://github.com/Fortnite-API/nodejs-wrapper"><img align="left" src="https://fortnite-api.com/assets/img/logo.png" height=128 width=128 /></a>
2+
3+
[![CI Status](https://github.com/Fortnite-API/nodejs-wrapper/actions/workflows/ci.yml/badge.svg)](https://github.com/Fortnite-API/nodejs-wrapper/actions/workflows/ci.yml)
4+
[![NPM Version](https://img.shields.io/npm/v/fnapicom.svg)](https://npmjs.com/package/fnapicom)
5+
[![NPM Downloads](https://img.shields.io/npm/dm/fnapicom.svg)](https://npmjs.com/package/fnapicom)
6+
[![MIT License](https://img.shields.io/npm/l/fnapicom.svg)](https://github.com/Fortnite-API/nodejs-wrapper/blob/master/LICENSE)
7+
[![Discord Server](https://discord.com/api/guilds/621452110558527502/widget.png)](https://discord.gg/hGzW8gSMCa)
8+
9+
A JavaScript / TypeScript wrapper for [Fortnite-API.com](https://fortnite-api.com/)
10+
11+
Note: This is the browser version. You can find the NodeJS version [here](https://github.com/Fortnite-API/nodejs-wrapper/tree/master)
12+
13+
<br />
14+
<hr />
15+
16+
<h2>Installation</h2>
17+
18+
```html
19+
<script src="https://raw.githubusercontent.com/Fortnite-API/nodejs-wrapper/web/FNAPIcom.js"></script>
20+
```
21+
22+
<h2>Usage example</h2>
23+
24+
```html
25+
<!DOCTYPE html>
26+
<html>
27+
<head>
28+
<meta charset="utf-8">
29+
<script src="https://raw.githubusercontent.com/Fortnite-API/nodejs-wrapper/web/FNAPIcom.js"></script>
30+
</head>
31+
<body>
32+
<pre id="response"></pre>
33+
<script>
34+
const client = new FNAPIcom.Client({
35+
language: FNAPIcom.Language.English,
36+
});
37+
38+
client.aesKeys().then((res) => {
39+
document.getElementById('response').innerText = JSON.stringify(res, null, 2);
40+
});
41+
</script>
42+
</body>
43+
</html>
44+
```
45+
46+
<h2>Links</h2>
47+
48+
- [NPM](https://npmjs.com/package/fnapicom)
49+
- [Docs](https://dash.fortnite-api.com/)
50+
- [Discord](https://discord.gg/hGzW8gSMCa)
51+
52+
<h2>License</h2>
53+
MIT License
54+
55+
Copyright (c) 2022 Nils S.
56+
57+
Permission is hereby granted, free of charge, to any person obtaining a copy
58+
of this software and associated documentation files (the "Software"), to deal
59+
in the Software without restriction, including without limitation the rights
60+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
61+
copies of the Software, and to permit persons to whom the Software is
62+
furnished to do so, subject to the following conditions:
63+
64+
The above copyright notice and this permission notice shall be included in all
65+
copies or substantial portions of the Software.
66+
67+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
68+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
69+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
70+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
71+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
72+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
73+
SOFTWARE.

0 commit comments

Comments
 (0)