Merge pull request #2 from goldmermaid/main

fixing readme

README.md

@@ -1,12 +1,5 @@
-# sec-agent-sdk
-No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-
-This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: 0.0.1
-- Package version: 1.0.0
-- Generator version: 7.5.0
-- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+# AI Agent for SEC Fillings
+The library is an experiment to extract SEC fillings data in real-time.
 
 ## Requirements.
 
@@ -19,10 +12,14 @@ pip install git+ssh://[email protected]:CambioML/aisec.git#main
 
 # Or
 
+pip install git+https://github.com/CambioML/aisec.git
+
+# Or
+
 poetry add git+ssh://[email protected]:CambioML/aisec.git#main
 ```
 
-🌱 Set up your AnyParser API key
+🌱 Set up your CambioML API key for AI SEC
 Please reach out at [email protected] for an API key.
 
 📜 Examples
@@ -45,8 +42,8 @@ with sec_agent_sdk.ApiClient(configuration) as api_client:
     api_instance = sec_agent_sdk.DefaultApi(api_client)
     form_type = FormType.EIGHT_K # FormType | 10-K | 10-Q | 8-K | 6-K
     company = 'AA' # ticker
-    table = FilingTable.BALANCE_SHEET # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet'
-    date_filed = '2024-04-17' # str (date string in YYYY-mm-dd) or None(the latest filing will be retrieved)
+    table = FilingTable.BALANCE_SHEET # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet' | 'business-segments-and-kpis'
+    date_filed = '2024-04-17' # optional str (date string in YYYY-mm-dd) or None(the latest filing will be retrieved)
 
     try:
         # Search sec filing