|
1 | | -# Very short description of the package |
| 1 | +<h1 align="center"> |
| 2 | +<img src="https://www.tibiawiki.com.br/images/c/c3/Tibiapedia.gif"/> Laravel TibiaData API |
| 3 | +</h1> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | +An open source library that allows you to access <a href="https://tibiadata.com/" target="_blank">TibiaData API</a> from your Laravel app. |
| 7 | +</p> |
2 | 8 |
|
3 | 9 | [](https://packagist.org/packages/igorsgm/tibia-data-api) |
4 | 10 | [](https://travis-ci.org/igorsgm/tibia-data-api) |
5 | 11 | [](https://scrutinizer-ci.com/g/igorsgm/tibia-data-api) |
6 | 12 | [](https://packagist.org/packages/igorsgm/tibia-data-api) |
7 | 13 |
|
8 | | -This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors. |
| 14 | +<a href="https://tibiadata.com/" target="_blank">TibiaData API</a> is a RESTful API providing information in JSON format containing information from Tibia’s official homepage tibia.com, so you can build your own small tools. |
| 15 | + |
| 16 | +## ✨ Features |
| 17 | + |
| 18 | +> - **Characters**: Get the pure information from characters of Tibia based on your character search. |
| 19 | +> - **Guilds**: List all guilds of a certain world or get detailed information of a certain guild. |
| 20 | +> - **Highscore**: List all highscores of a certain world and see who got the right skills to top the list. |
| 21 | +> - **Houses**: List all houses in all the different worlds and towns of Tibia. |
| 22 | +> - **News**: The latest 6 months of news and articles from tibia.com. |
| 23 | +> - **Worlds**: List all worlds of Tibia or list all online players and more info of your favorite world. |
9 | 24 |
|
10 | | -## Installation |
| 25 | +## 1️⃣ Installation |
11 | 26 |
|
12 | 27 | You can install the package via composer: |
13 | 28 |
|
14 | 29 | ```bash |
15 | 30 | composer require igorsgm/tibia-data-api |
16 | 31 | ``` |
17 | 32 |
|
18 | | -## Usage |
| 33 | +## 2️⃣ Usage |
19 | 34 |
|
20 | 35 | ``` php |
21 | | -// Usage description here |
22 | | -``` |
23 | | - |
24 | | -### Testing |
25 | | - |
26 | | -``` bash |
27 | | -composer test |
| 36 | +TibiaDataApi::characters()->get('Bobeek') |
| 37 | +TibiaDataApi::highscores()->get('Antica', 'sword', 'all') |
| 38 | +TibiaDataApi::houses()->get('Antica', 'Thais', 'houses') |
| 39 | + |
| 40 | +// Guilds |
| 41 | +TibiaDataApi::guild()->get('Red Rose') |
| 42 | +TibiaDataApi::guilds()->get('Antica') |
| 43 | + |
| 44 | +// Worlds |
| 45 | +TibiaDataApi::worlds()->getList() |
| 46 | +TibiaDataApi::worlds()->get('Antica') |
| 47 | + |
| 48 | +// News |
| 49 | +TibiaDataApi::news()->get(3560) |
| 50 | +TibiaDataApi::news()->getLatestNews() |
| 51 | +TibiaDataApi::news()->getNewstickers() |
28 | 52 | ``` |
29 | 53 |
|
30 | | -### Changelog |
31 | | - |
32 | | -Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. |
33 | | - |
34 | 54 | ## Contributing |
35 | 55 |
|
36 | 56 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details. |
37 | 57 |
|
38 | | -### Security |
39 | | - |
40 | | -If you discover any security related issues, please email [email protected] instead of using the issue tracker. |
41 | | - |
42 | 58 | ## Credits |
43 | 59 |
|
| 60 | +- Tibia and TibiaME are trademarks of CipSoft GmbH. The official website for Tibia is [Tibia.com](https://tibia.com) |
| 61 | +- [TibiaData API](https://tibiadata.com/) |
| 62 | +- [Simivar](https://github.com/simivar) |
44 | 63 | - [Igor Moraes](https://github.com/igorsgm) |
45 | 64 |
|
46 | 65 | ## License |
|
0 commit comments