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

Commit b76dce6

Browse files
authored
Create README.md
0 parents  commit b76dce6

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<div align="center">
2+
3+
# Ruby wrapper for [Fortnite-API.com](https://fortnite-api.com)
4+
5+
</div>
6+
7+
This repository offers an request API around the endpoints of [fortnite-api.com](https://fortnite-api.com).
8+
9+
## Installation
10+
11+
To install this gem, simply type into your terminal:
12+
```gem install fortniteapi```
13+
14+
## Example
15+
16+
```ruby
17+
require 'fortniteapi'
18+
19+
fortnite_api = FortniteAPI.new()
20+
cosmetics = fortnite_api.search_cosmetic('Renegade')
21+
puts cosmetics.id
22+
=> cid_013_athena_commando_f
23+
```
24+
25+
## Documentation
26+
27+
To see the full documentation for this gem, please visit the [wiki](https://github.com/Fortnite-API/ruby-wrapper/wiki)
28+
29+
## License
30+
31+
Fortnite-API (MIT) [License](https://github.com/Fortnite-API/ruby-wrapper/blob/master/LICENSE "MIT License")
32+
33+
API developed by [Fortnite-API.com](https://fortnite-api.com/about)

0 commit comments

Comments
 (0)