Skip to content

Commit bbea64d

Browse files
committed
Fix README file with html tags
1 parent a744c5d commit bbea64d

File tree

1 file changed

+41
-35
lines changed

1 file changed

+41
-35
lines changed

README.md

Lines changed: 41 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,56 @@
1-
This app is designed to help anyone whether you're a seasoned investor, curious enthusiast, or someone new to the stock market - analyze and understand stock performance with ease. With just a few clicks, you can access essential stock data and insights in a clear, interactive format.
1+
This app is designed to help anyone - whether you're a seasoned investor, curious enthusiast, or someone new to the stock market - analyze and understand stock performance with ease. With just a few clicks, you can access essential stock data and insights in a clear, interactive format.
22

33
The Stock Analysis Dashboard fetches real-time stock information from **Yahoo Finance** and presents it in an easy-to-understand format. It includes:
4-
- **Company Profiles**: Learn about the company behind the ticker.
5-
- **Performance Analysis**: View price trends and interactive charts to see how a stock has performed over time.
6-
- **Financial Statements**: Access key reports such as:
7-
<pre>
8-
- Balance Sheet
9-
- Income Statement
10-
- Cash Flow Statement
11-
</pre>
12-
- **Flexible Reporting**: Choose between annual or quarterly financial reports to suit your analysis need
4+
<ul>
5+
<li><strong>Company Profiles</strong>: Learn about the company behind the ticker.</li>
6+
<li><strong>Performance Analysis</strong>: View price trends and interactive charts to see how a stock has performed over time.</li>
7+
<li><strong>Financial Statements</strong>: Access key reports such as Balance Sheet, Income Statement and Cash Flow Statement.</li>
8+
<li><strong>Flexible Reporting</strong>: Choose between annual or quarterly financial reports to suit your analysis need.</li>
9+
</ul>
10+
1311

1412
### How to Use the Dashboard
15-
1. **Search for a Stock**:
16-
<pre>
17-
- Type a stock ticker (e.g., `AAPL` for Apple, `TSLA` for Tesla, or `MSFT` for Microsoft) into the search bar.
18-
- Hit enter, and the dashboard will display comprehensive information about the stock.
19-
</pre>
20-
2. **Explore Key Features**:
21-
<pre>
22-
- **Interactive Charts**: Easily visualize the stock's performance over time.
23-
- **Key Metrics**: View important data like market capitalization, P/E ratio, and earnings per share (EPS).
24-
- **Detailed Financials**: Dive into the company's financial reports to gain deeper insights.
25-
</pre>
13+
<ol>
14+
<li><strong>Search for a Stock</strong></li>
15+
<ul>
16+
<li>Type a stock ticker (e.g., <strong>AAPL</strong> for Apple, <strong>TSLA</strong> for Tesla, or <strong>MSFT</strong> for Microsoft) into the search bar.</li>
17+
<li>Hit enter, and the dashboard will display comprehensive information about the stock.</li>
18+
</ul>
19+
<li><strong>Explore Key Features</strong></li>
20+
<ul>
21+
<li><strong>Interactive Charts</strong>: Easily visualize the stock's performance over time.</li>
22+
<li><strong>Key Metrics</strong>: View important data like market capitalization, P/E ratio, and earnings per share (EPS).</li>
23+
<li><strong>Detailed Financials</strong>: Dive into the company's financial reports to gain deeper insights.</li>
24+
</ul>
25+
</ol>
26+
2627

2728
### Need Some Inspiration?
2829
Here are a few popular stock tickers to get started:
29-
- `AAPL`: Apple Inc.
30-
- `GOOGL`: Alphabet Inc.
31-
- `AMZN`: Amazon.com, Inc.
32-
- `MSFT`: Microsoft Corporation
33-
- `TSLA`: Tesla, Inc.
30+
<ul>
31+
<li><strong>AAPL</strong>: Apple Inc.</li>
32+
<li><strong>GOOGL</strong>: Alphabet Inc.</li>
33+
<li><strong>AMZN</strong>: Amazon.com, Inc.</li>
34+
<li><strong>MSFT</strong>: Microsoft Corporation</li>
35+
<li><strong>TSLA</strong>: Tesla, Inc.</li>
36+
</ul>
3437

3538
### Why Use This Dashboard?
36-
37-
- **User-Friendly Interface**: Intuitive and easy to navigate, even for beginners.
38-
- **Comprehensive Data**: All the key stock metrics and financials in one place.
39-
- **Free to Use**: Gain valuable market insights without any cost.
39+
<ul>
40+
<li><strong>User-Friendly Interface</strong>: Intuitive and easy to navigate, even for beginners.</li>
41+
<li><strong>Comprehensive Data</strong>: All the key stock metrics and financials in one place.</li>
42+
<li><strong>Free to Use</strong>: Gain valuable market insights without any cost.</li>
43+
</ul>
4044

4145
### Technologies Behind the Dashboard
4246
To deliver a seamless experience, the Stock Analysis Dashboard leverages the following technologies:
4347

44-
- **Python**: The backbone of the application, used for data fetching and processing.
45-
- **Yahoo Finance API**: For retrieving real-time stock data and financial reports.
46-
- **Streamlit**: A powerful framework for building interactive and user-friendly web applications.
47-
- **Pandas**: For efficient data manipulation and analysis.
48-
- **Plotly**: For creating interactive and visually appealing charts.
48+
<ul>
49+
<li><strong>Python</strong>: The backbone of the application, used for data fetching and processing.</li>
50+
<li><strong>Yahoo Finance API</strong>: For retrieving real-time stock data and financial reports.</li>
51+
<li><strong>Streamlit</strong>: A powerful framework for building interactive and user-friendly web applications.</li>
52+
<li><strong>Pandas</strong>: For efficient data manipulation and analysis.</li>
53+
<li><strong>Plotly</strong>: For creating interactive and visually appealing charts.</li>
54+
</ul>
4955

5056
These technologies work together to provide accurate, real-time data in an easy-to-use interface.

0 commit comments

Comments
 (0)