From 3347b755ee8c27388c956dd9999a496cbfe51691 Mon Sep 17 00:00:00 2001
From: Xmk <i@ars-team.ru>
Date: Wed, 3 Jul 2024 15:19:02 +0300
Subject: [PATCH] basic docs

---
 README.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 81 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8f09661..9fcc55e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,81 @@
-# infloflot-api
\ No newline at end of file
+# infloflot-api
+
+basic docs:
+
+https://restapi.infoflot.com/docs
+
+
+## client initialization
+```php
+require 'vendor/autoload.php';
+
+use CryptoWeb\InfoflotApi\Client;
+use CryptoWeb\InfoflotApi\ClientOptions;
+
+$client = new Client(
+	new GuzzleHttp\Client(),
+	new ClientOptions(
+		apiKey: 'your-api-key',
+	)
+);
+```
+
+## usage basic
+```php
+$result = $client->request('cruises', ['id' => 123]);
+```
+
+## builders
+```php
+use CryptoWeb\InfoflotApi\Builders\Cruises;
+use CryptoWeb\InfoflotApi\Builders\CruisesId;
+use CryptoWeb\InfoflotApi\Builders\CruisesIdCabins;
+use CryptoWeb\InfoflotApi\Builders\CruisesIdCabinsSearch;
+
+// get all cruises
+$cruisesBuilder = new Cruises($client);
+$cruisesBuilder->nights(5);
+$cruisesResult = $cruisesBuilder->get();
+
+// or
+$cruisesResult = (new Cruises($client))
+	->nights(5)
+	->get();
+
+// get cruise by id
+$cruiseBuilder = new CitiesId($client);
+$cruiseBuilder->id(123);
+$cruiseResult = $cruiseBuilder->get();
+
+// get cruise cabins by id
+$cruiseCabinsResult = (new CruisesIdCabins($client))
+	->id(123)
+	->get();
+
+// etc.
+```
+
+## factory
+```php
+use CryptoWeb\InfoflotApi\Infoflot;
+
+$infoflot = new Infoflot($client);
+
+$infoflot->cruises()
+	->nights(5)
+	->get();
+
+$infoflot->cruises(100500)
+	->get();
+
+$infoflot->cruises(100500)
+	->cabins()
+	->get();
+
+$infoflot->cruises(100500)
+	->cabins()
+	->search()
+	->get();
+
+// etc.
+```