Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vianpyro authored Feb 29, 2024
1 parent 0c3a1d2 commit f4cbc3e
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# league_of_help
v2
# League of Help

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Description

League of Help is a web page dedicated to providing comprehensive information about champions from the game League of Legends. It aims to make all essential information accessible and intuitive to find in one place, including champion abilities, recommended item builds, and community tips.

## Usage

To use the project, simply visit the website: [League of Help](https://vianpyro.github.io/league_of_help). Once there, users can browse the list of champions, click on a champion to view their abilities, recommended item build, and any community tips available.

## Contributing

Contributions to the project are welcome! If you'd like to contribute, you can fork the repository, make your changes, and then submit a pull request. I'll gladly review and merge your contributions.

## License

This project is licensed under the terms of the MIT License. See the [LICENSE](LICENSE) file for details.

## Acknowledgments

I would like to thank Martin 'Cozax' B. for his invaluable help and guidance, answering numerous questions about JavaScript during the development of this project.

## Known Issues

Currently, there is one known issue/limitation in the project: due to a deprecated part of the API, retrieving recommended items for champions may result in longer loading times, especially for champions with recommendations spanning multiple patches. This issue causes delays of about fifteen seconds while the code loops through past patches to find the specified items for the selected champion.

0 comments on commit f4cbc3e

Please sign in to comment.