Updated README.md

Author: KVignesh122

.gitignore

@@ -8,6 +8,6 @@ __pycache__/*
 oai.py
 main-mine.py
 websearch copy.py
-*.jpg
 plotting.py
 sbc.py
+*.pyc

README.md

@@ -1,6 +1,32 @@
 # Asset News Sentiment Analyzer
 
-This application provides two sophisticated tools catering to sentimental analysis of financial assets and securities through Google search results and online news articles. You will just need an OpenAI API Key to get started and utilize the power of all the functionalities provided by this package, namely to fetch news articles, analyze their content, and produce insightful reports for investment and trading decisions.
+This application provides two sophisticated tools catering to sentiment analysis of financial assets and securities through Google search results and online news articles. You will just need an OpenAI API Key to get started and utilize the power of all the functionalities provided by this package, namely to fetch news articles, analyze their content, and produce insightful reports for investment and trading decisions.
+
+A simple trading strategy involving daily sentiment analysis signals from this package may provide basic market traction of the target asset (We did a sample backtest on commodities over the past 100 market days):
+
+<table>
+  <tr>
+    <td align="center">
+      <strong>Crude Oil 100 Days</strong><br>
+      <img src="images/Crude Oil.jpg" alt="Crude Oil Sample" width="500" height="300">
+    </td>
+    <td align="center">
+      <strong>Gold 100 Days</strong><br>
+      <img src="images/Gold.jpg" alt="Gold Sample" width="500" height="300">
+    </td>
+  </tr>
+</table>
+
+***Disclaimer: All investments and trading involve risk. This package is intended for research/academic purposes, and coding projects. It aids algorithmic/quantitative traders and researchers in their work. The reports and signals generated by this package does not constitute financial advice, and users should perform their own due diligence before making any trading decisions.***
+
+## Contents
+
+- [Two Main Classes](#two-main-classes)
+  - [SentimentAnalyzer Tool](#1-sentimentanalyzer-tool)
+  - [WebInteractor Tool](#2-webinteractor-tool)
+- [Installation](#installation)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Two Main Classes
 
@@ -42,7 +68,7 @@ __Available Methods:__
 * `.fetch_news_links()`: Fetches news links from Google Search News tab for the specified asset on the given date. If `news_date` parameter is not assigned, it will retrieve the current day's latests news links. `nlinks` parameter denotes the number of news links to retrieve, default is `4`.
 * `.show_news_content(<news_url>)`: Parses and returns main content as string for a given news URL.
 * `.get_sentiment()`: Analyzes online results automatically and returns the news sentiment for asset/security on any given date. If `date` parameter is not assigned, it will return the current day's latest sentiment verdict.
-* `produce_daily_report()`: Generates a daily report returned as string with insights based on the online Google Search content for any given date. If `date` parameter is not assigned, it will generate report for the current day. The default `max_words` is `100`, but this can be adjusted as preferred.
+* `.produce_daily_report()`: Generates a daily report returned as string with insights based on the online Google Search content for any given date. If `date` parameter is not assigned, it will generate report for the current day. The default `max_words` is `100`, but this can be adjusted as preferred.
 
 Note: All dates must be in `MM-dd-YYYY` format or must be passed as a `datetime.datetime` object into the methods.
 
@@ -112,3 +138,20 @@ Project has been published on pip
 ```bash
 pip install asset-sentiment-analyzer
 ```
+
+## Contributing
+
+If you would like to contribute to this project, please follow the guidelines below:
+
+- Fork the repository.
+- Create a new branch (git checkout -b feature-branch).
+- Make your changes.
+- Commit your changes (git commit -m 'Add new feature').
+- Push to the branch (git push origin feature-branch).
+- Open a pull request.
+
+## License
+
+This project is pioneered by SkyBlue Capital (Singapore), and is licensed under the Apache-2.0 License. See the LICENSE file for details.
+
+<img src="images/HBlack.png" alt="SBC Logo" width="190" height="55">

images/Crude Oil.jpg

@@ -2,7 +2,7 @@
 
 setup(
     name='asset_sentiment_analyzer',
-    version='0.1.3',
+    version='0.1.4',
     description='A sentiment analyzer package for financial assets and securities utilizing GPT models.',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',