Brasileirão
Getting Started
Prerequisites
node -v
node: v18
Installing
Using npm
npm install --save brasileirao
Using Yarn
yarn add brasileirao
How to use
// const {table} = require('brasileirao')
import {table} from "brasileirao"
// Returns the classification of the Brasileirão A
const serieA = table('a')
/**
* Get all table data:
[
{
position: 1,
team: 'Fluminense',
acronym: 'FLU',
shield: '...fluminense.png',
popularName: 'Fluminense',
points: 6,
played: 2,
wins: 2,
draws: 0,
losses: 0,
goalsFor: 5,
goalsAgainst: 0,
goalDifference: 5,
winPercentage: 100,
recentResults: null,
positionChange: null
},
...
*/
// const {match} = require('brasileirao')
import {match} from "brasileirao"
// Returns the current match of the Brasileirão B
const partidas = match('b')
/**
* Get currents match data:
{
"round_information": {
"current": 3,
"last": 38
},
"matches": [
{
"match_date": "2023-04-28T19:00",
"match_time": "19:00",
"teams": {
"home_team": {
"badge": "...criciuma.svg",
"name": "Criciúma",
"abbreviation": "CRI"
},
"away_team": {
"badge": "...avai-futebol-clube.svg",
"name": "Avaí",
"abbreviation": "AVA"
}
},
"home_team_score": null,
"away_team_score": 0,
"stadium": {
"name": "Heriberto Hülse"
}
},
...
*/
Roadmap
- [x] Serie A table
- [x] Serie B table
- [ ] Serie C table
- [x] Results of the Series A round
- [x] Results of the Series B round
- [ ] Games of the day
Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
- Make a fork;
- Create a branck with your feature:
git checkout -b my-feature
; - Commit changes:
git commit -m 'feat: My new feature'
; - Make a push to your branch:
git push origin my-feature
.
After merging your receipt request to done, you can delete a branch from yours.
Running the tests
To run the tests go to the terminal and enter npm run test
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Show your support
Give a
📝 License
This project is under the MIT license. See the LICENSE for details.
Made with