update readme.md

README.md

@@ -4,6 +4,11 @@
 
 This is the official GOAPI.IO SDK for PHP. It provides a set of functions and classes to interact with the Goapi API.
 
+## Requirements
+
+- PHP 8.1 or higher
+- GuzzleHttp library
+
 ## Installation
 
 You can install the SDK using Composer. Run the following command in your project directory:
@@ -12,7 +17,9 @@ You can install the SDK using Composer. Run the following command in your projec
 composer require goapi-io/php-sdk
 ```
 
-## Usage
+## Stock Market Data (IDX)
+
+### Create Instance
 
 To use the SDK, you need to include the autoloader and create an instance of the main class. Here is an example:
 
@@ -21,16 +28,65 @@ require 'vendor/autoload.php';
 
 $client = new GOAPI\IO\Client(['api_key' => 'your_api_key']);
 
-$stockIDX = $client->createStockIDX();
+$marketDataIDX = $client->createStockIDX();
+```
+
+### Get all listed companies
 
-// Use the client to call various API endpoints
-$response = $client->getCompanies();
+```php
+$companies = $marketDataIDX->getCompanies();
 ```
 
-## Requirements
+The `$companies` response is a [`Collection`](src/Collection.php) with [`GOAPI\IO\Resources\Stock\Company`](src/Resources/Stock/Company.php) items data.
 
-- PHP 8.1 or higher
-- GuzzleHttp library
+### Get Detail Company Profile
+
+```php
+$profile = $marketDataIDX->getProfile('BBCA');
+```
+
+### Get price by symbols
+
+```php
+$prices = $marketDataIDX->getStockPrices(['AALI','BBCA']);
+```
+
+The `$prices` is a [`Collection`](src/Collection.php) with [`StockPrice`](src/Resources/Stock/StockPrice.php) items data.
+
+### Get historical price by symbol
+
+```php
+// maximum date range (from-to) is 1 year.
+$historicalPrice = $marketDataIDX->getHistoricalData('BBCA', '2023-10-01', '2023-10-20');
+```
+
+The `$historicalPrice` is a [`Collection`](src/Collection.php) with [`StockPrice`](src/Resources/Stock/StockPrice.php) items data.
+
+### Get trending, top loser, top gainer
+
+```php
+$trending = $marketDataIDX->getTrendingStocks();
+$gainer = $marketDataIDX->getTopGainerStocks();
+$loser = $marketDataIDX->getTopLoserStocks();
+```
+
+The `$trending`,`$gainer`, `$loser` is a [`Collection`](src/Collection.php) with [`StockPriceChange`](src/Resources/Stock/StockPriceChange.php) items data.
+
+### Get Broker Summary
+
+```php
+$brokerSum = $marketDataIDX->getBrokerSummary('BBCA', '2023-10-30');
+```
+
+The `$brokerSum` is a [`Collection`](src/Collection.php) with [`BrokerSummary`](src/Resources/Stock/BrokerSummary.php) items data.
+
+### Get stock indicators
+
+```php
+$indicators = $marketDataIDX->getStockIndicators(page: 1, date: '2023-10-30');
+```
+
+The `$indicators` is a [`Collection`](src/Collection.php) with [`StockIndicator`](src/Resources/Stock/StockIndicator.php) items data.
 
 ## Contributing