From 46f9904db0e76e22902fa2c8eb6340110e7b5e7a Mon Sep 17 00:00:00 2001
From: Benny Thadikaran <tbenny05@yahoo.com>
Date: Fri, 3 Nov 2023 11:11:34 +0530
Subject: [PATCH] - Version 2.0.0 - Updated README - Added class init
 documentation

---
 README.md             | 18 ++++++++----------
 docs/source/conf.py   |  2 +-
 docs/source/usage.rst |  2 ++
 pyproject.toml        |  2 +-
 4 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 6636019..267af79 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Python version: >= 3.10
 ## Install with PIP
 
 ```
-pip install bse
+pip install -U bse
 ```
 
 ## Documentation
@@ -23,14 +23,12 @@ Using with statement
 ```python
 from bse import BSE
 
-with BSE() as bse:
-    scripCode = bse.getScripCode('tcs') # 532540 bse scrip code
+with BSE(download_folder='./') as bse:
+    scripCode = bse.getScripCode('tcs')  # 532540 bse scrip code
 
-    bse.getScripName('532540') # TCS
+    data = bse.actions(scripcode=scripCode)
 
-    data = bse.corporateActions(scripCode)
-
-    oclc = bse.quote(scripCode) # Open, High, Low, LTP
+    ohlc = bse.quote(scripCode)  # Open, High, Low, LTP
 ```
 
 or
@@ -39,13 +37,13 @@ or
 from bse import BSE
 from bse.constants import INDEX
 
-bse = BSE()
+bse = BSE(download_folder='./')
 
-code = bse.getScripCode('tcs') # 532540 bse scrip code
+code = bse.getScripCode('tcs')  # 532540 bse scrip code
 
 gainers = bse.gainers(by='index', name=INDEX.BSE500)
 
-bse.exit() # close the request session
+bse.exit()  # close the request session
 ```
 
 ## Sample Responses
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 8980bd5..7fffc49 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -16,7 +16,7 @@
 project = 'bse'
 copyright = '2023, Benny Thadikaran'
 author = 'Benny Thadikaran'
-release = '1.0.0'
+release = '2.0.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
index e34b1d5..702195a 100644
--- a/docs/source/usage.rst
+++ b/docs/source/usage.rst
@@ -31,6 +31,8 @@ Example
 API
 ___
 
+.. autoclass:: bse.BSE
+
 General Methods
 ---------------
 
diff --git a/pyproject.toml b/pyproject.toml
index 22d17b7..ee266ed 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bse"
-version = "1.0.0"
+version = "2.0.0"
 authors = [
   { name="Benny Thadikaran" },
 ]