Skip to content
This repository was archived by the owner on Oct 31, 2024. It is now read-only.

Commit 91ebdd1

Browse files
author
NotOfficer
authored
Update README.md
1 parent 8186431 commit 91ebdd1

File tree

1 file changed

+54
-2
lines changed

1 file changed

+54
-2
lines changed

README.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,54 @@
1-
# csharp-wrapper
2-
Coming soon...
1+
<div align="center">
2+
3+
# C# wrapper for [Fortnite-API.com](https://fortnite-api.com)
4+
5+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Fortnite-API/csharp-wrapper)](https://github.com/Fortnite-API/csharp-wrapper/releases) [![NuGet](https://img.shields.io/nuget/vpre/Fortnite-API-Wrapper.svg?maxAge=2592000?style=plastic)](https://www.nuget.org/packages/Fortnite-API-Wrapper) [![GitHub issues](https://img.shields.io/github/issues/Fortnite-API/csharp-wrapper)](https://github.com/Fortnite-API/csharp-wrapper/issues) [![MIT License](https://img.shields.io/github/license/Fortnite-API/csharp-wrapper)](https://github.com/Fortnite-API/csharp-wrapper/blob/master/LICENSE)
6+
7+
</div>
8+
9+
This library offers a complete wrapper around the endpoints of [fortnite-api.com](https://fortnite-api.com).
10+
11+
## NuGet
12+
13+
Install-Package GameOverlay.Net -Version 4.0.6
14+
15+
## Documentation
16+
17+
Here is a quick overview of the API so you can get started very quickly.
18+
19+
If you need an in-use example then please take a look at the [program.cs](https://github.com/Fortnite-API/csharp-wrapper/blob/master/src/Fortnite-API.Test/Program.cs) in my test folder where i use some of the endpoints.
20+
21+
- General usage
22+
23+
```cs
24+
using Fortnite_API;
25+
26+
var api = new FortniteApi();
27+
```
28+
29+
- FortniteApi class
30+
31+
```cs
32+
var api = new FortniteApi();
33+
34+
// accesses the shop endpoint (https://fortnite-api.com/shop)
35+
api.Shop...
36+
37+
// accesses the cosmetics endpoint (https://fortnite-api.com/cosmetics)
38+
api.Cosmetics...
39+
40+
// accesses the news endpoint (https://fortnite-api.com/news)
41+
api.News...
42+
```
43+
44+
### Contribute
45+
46+
If you can provide any help, may it only be spell checking please contribute!
47+
48+
We are open for any contribution.
49+
50+
## License
51+
52+
- Fortnite-API (MIT) [License](https://github.com/Fortnite-API/csharp-wrapper/blob/master/LICENSE "MIT License")
53+
54+
API developed by [Fortnite-API.com](https://fortnite-api.com/about)

0 commit comments

Comments
 (0)