fix: docs

npldevfr · Jan 30, 2024 · 8eea21e · 8eea21e
1 parent 0806980
commit 8eea21e
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 4 deletions.
diff --git 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
@@ -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
+<?php
+
+use Npldevfr\Liquipedia\Liquipedia;
+use Npldevfr\Liquipedia\Meta\Endpoint;
+use Npldevfr\Liquipedia\Meta\Wiki;
+
+$liquipediaSdk = new Liquipedia('your-api-key');
+
+// Get the last 10 matches of Team Liquid on League of Legends
+$matches = $liquipediaSdk->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          | ❌      |
+
+
+
+