Skip to content

Commit 8ae2cc4

Browse files
committed
README.md updated
1 parent acf56f4 commit 8ae2cc4

File tree

1 file changed

+38
-19
lines changed

1 file changed

+38
-19
lines changed

README.md

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,65 @@
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>
28

39
[![Latest Version on Packagist](https://img.shields.io/packagist/v/igorsgm/tibia-data-api.svg?style=flat-square)](https://packagist.org/packages/igorsgm/tibia-data-api)
410
[![Build Status](https://img.shields.io/travis/igorsgm/tibia-data-api/master.svg?style=flat-square)](https://travis-ci.org/igorsgm/tibia-data-api)
511
[![Quality Score](https://img.shields.io/scrutinizer/g/igorsgm/tibia-data-api.svg?style=flat-square)](https://scrutinizer-ci.com/g/igorsgm/tibia-data-api)
612
[![Total Downloads](https://img.shields.io/packagist/dt/igorsgm/tibia-data-api.svg?style=flat-square)](https://packagist.org/packages/igorsgm/tibia-data-api)
713

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.
924
10-
## Installation
25+
## 1️⃣ Installation
1126

1227
You can install the package via composer:
1328

1429
```bash
1530
composer require igorsgm/tibia-data-api
1631
```
1732

18-
## Usage
33+
## 2️⃣ Usage
1934

2035
``` 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()
2852
```
2953

30-
### Changelog
31-
32-
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
33-
3454
## Contributing
3555

3656
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
3757

38-
### Security
39-
40-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
41-
4258
## Credits
4359

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)
4463
- [Igor Moraes](https://github.com/igorsgm)
4564

4665
## License

0 commit comments

Comments
 (0)