From 8eea21e5942814f5891bf8997c6ab9f3f700ee6b Mon Sep 17 00:00:00 2001 From: npldevfr Date: Tue, 30 Jan 2024 21:05:34 +0100 Subject: [PATCH] fix: docs --- docs/guide/getting-started.md | 10 ++++-- docs/guide/what-is-liquipedia-client.md | 44 ++++++++++++++++++++++++- 2 files changed, 50 insertions(+), 4 deletions(-) diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index db319fd..a1b4127 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -4,12 +4,16 @@ outline: deep # Getting Started -## Installation +## Requirements -The Liquipedia PHP Client can be installed via [Composer](https://getcomposer.org/). +- ``PHP >= 8.2`` +- [Composer](https://getcomposer.org/) +- [Liquipedia API Key](https://api.liquipedia.net) +- [Liquipedia Documentation](https://liquipedia.net) -> Note: Requires PHP 8.2 or higher. +## Installation +The Liquipedia PHP Client can be installed via [Composer](https://getcomposer.org/). ```bash composer require npldevfr/liquipedia-client diff --git a/docs/guide/what-is-liquipedia-client.md b/docs/guide/what-is-liquipedia-client.md index 0ba3d08..0d01da3 100644 --- a/docs/guide/what-is-liquipedia-client.md +++ b/docs/guide/what-is-liquipedia-client.md @@ -2,6 +2,48 @@ outline: deep --- -# What is Liquipedia PHP Client? +## What is Liquipedia PHP Client? The Liquipedia PHP Client serves as a PHP software development kit (SDK) designed to simplify and enhance the utilization of the latest Liquipedia v3 API through custom methods and endpoints. + +## Example + +```php +query() + ->endpoint(Endpoint::MATCHES) + ->wikis(Wiki::LEAGUE_OF_LEGENDS) + ->rawConditions('[[opponent::Team Liquid]]') + ->limit(10) + ->orderBy('date', 'desc') + ->get(); + + +``` + +## Roadmap + +The Liquipedia PHP Client is currently in development and is not yet ready for production use. The following features are planned for the first release: + +| Feature | Status | +|---------------------------|--------| +| Liquipedia API v3 support | ✅ | +| Custom query builder | ✅ | +| Extensible | ✅ | +| Documentation | ❌ | +| Examples | ❌ | +| Tests | ✅ | +| Endpoint methods | ❌ | +| Endpoint classes | ❌ | + + + +