Skip to content

FinceptTerminal is a modern finance application offering advanced market analytics, investment research, and economic data tools, designed for interactive exploration and data-driven decision-making in a user-friendly environment.

readme update

tilakpatel22e133ae39e59b
diff --git a/README.md b/README.md
index ae33d4332..7f4cf342d 100644
--- a/README.md
+++ b/README.md
@@ -1,125 +1,174 @@
# Fincept Terminal ✨
-[![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/yourusername/fincept-investments/blob/main/LICENSE.txt)
+<div align="center">
+
+[![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/Fincept-Corporation/FinceptTerminal/blob/main/LICENSE.txt)
[![PyPI version](https://badge.fury.io/py/fincept-terminal.svg)](https://badge.fury.io/py/fincept-terminal)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fincept-terminal.svg)](https://pypi.org/project/fincept-terminal/)
+[![Python 3.8+](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![Hits](https://hits.sh/github.com/Fincept-Corporation/FinceptTerminal.svg?label=Visits)](https://hits.sh/github.com/Fincept-Corporation/FinceptTerminal/)
[![PyPI Downloads](https://static.pepy.tech/badge/fincept-terminal)](https://pepy.tech/projects/fincept-terminal)
+### *Professional Financial Analysis Platform*
+**The GUI-powered investment terminal that brings Bloomberg-level insights to everyone**
-**Fincept Terminal** is a comprehensive Command Line tool that helps in Investment research, Extracting financial insights, market analysis, and a lot of other financial services such as technical analysis, fundamental analysis, sentiment analysis, quantitative analysis, and economic data analysis. It's designed to help investors and financial professionals navigate the complex world of investments with ease and precision.
+[🚀 Quick Start](#-installation) • [✨ Features](#-features) • [📱 Desktop App](#-desktop-app) • [🤝 Contribute](#-become-a-contributor)
-![Fincept Terminal](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/FinceptTerminalDashboard.png)
+![Fincept Terminal](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Dashboard.png)
-## Features 🧐
+</div>
-- **Dynamic Asset Searching**: we have an comprehensive list of assets from around the world
-- **Economics**: Get economic indicators and analysis (Feature under development).
-- **Global News**: Stay updated with top financial news across the globe.
-- **Technical Analysis**: Perform technical analysis on stocks and market indices.
-- **Fundamental Analysis**: Dive deep into the fundamentals of companies.
-- **Sentiment Analysis**: Gauge market sentiment with real-time data.
-- **Portfolio Management**: Create and Manage Custom made portfolios within your local machine.
-- **Quantitative Analysis**: Analyze financial data using quantitative methods.
-- **Economic Data**: Access key economic indicators to inform your investment decisions.
-- **Robo Advisor**: Auto Generate Portfolios with the help of robo advisor.
-- **BackTesting**: Easily Backtest your strategy or portfolios on our terminal with some keyword inputs.
-- **Scanner**: Find the Breakout Stocks in realtime with using our Scanner feature which provides you best results on current market.
-- **GenAI**: Get Customize recommendation on stocks or portfolio through GenAI one of the first Financial Terminal with AI Implemented in it.
+---
-## Installation 🚀
+## 🎯 What is Fincept Terminal?
-### **Option 1: Install via `pip`**
-Install the latest version of Fincept Terminal from PyPI:
-```sh
-pip install fincept-terminal==1.0.8
-```
+**Fincept Terminal** is a comprehensive GUI-based financial analysis platform that democratizes professional investment tools. With an intuitive interface and powerful analytics engine, it's designed for investors, traders, and financial professionals who demand institutional-grade insights without the institutional price tag.
-### **Option 2: Using a Virtual Environment (Recommended)**
-Before installing, it's best to create a virtual environment:
+### 🌟 Why Choose Fincept Terminal?
-#### **On Windows (CMD/PowerShell)**
-```sh
-python -m venv fincept-terminal-env
-fincept-terminal-env\Scripts\activate
-```
+| Traditional Platforms | Fincept Terminal |
+|----------------------|------------------|
+| 💸 Expensive subscriptions | 🆓 **Completely Free** |
+| 🏢 Enterprise-only access | 👤 **Available to Everyone** |
+| ⚙️ Limited customization | 🎨 **Fully Customizable** |
+| 📊 Basic charting | 📈 **Advanced Analytics** |
+| 🔒 Closed ecosystem | 🌐 **Open Source** |
-#### **On macOS/Linux**
-```sh
-python -m venv fincept-terminal-env
-source fincept-terminal-env/bin/activate
-```
+## ✨ Features
-Once the virtual environment is activated, install Fincept Terminal:
-```sh
-pip install fincept-terminal==1.0.8
-```
+<div align="center">
+<table>
+<tr>
+<td width="50%">
-### **Option 3: Download the Desktop App**
-[![Download Fincept Terminal](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/download-windows.svg)](https://github.com/Fincept-Corporation/FinceptTerminal/releases/download/Production1.0.0/FinceptInvestmentsInstaller.exe)
+### 📊 **Market Intelligence**
+- 🌍 **Global Asset Coverage** - Stocks, forex, crypto, commodities
+- 📈 **Real-Time Data Streaming** - Live market feeds and updates
+- 📰 **Financial News Integration** - Global news and market insights
+- 🔍 **Dynamic Asset Search** - Comprehensive worldwide database
----
+### 🧠 **AI-Powered Analysis**
+- 🤖 **GenAI Integration** - First financial terminal with built-in AI
+- 📊 **Sentiment Analysis** - Real-time market sentiment tracking
+- 💡 **Robo Advisor** - Automated portfolio recommendations
+- 🎯 **Stock Scanner** - AI-driven breakout stock detection
+
+</td>
+<td width="50%">
+
+### 📈 **Professional Tools**
+- 📊 **Technical Analysis** - Advanced charting and indicators
+- 💼 **Fundamental Analysis** - Deep company research
+- 📋 **Portfolio Management** - Create and track custom portfolios
+- ⚡ **Backtesting Engine** - Test strategies with historical data
+
+### 🌐 **Advanced Features**
+- 🗺️ **Maritime Trade Routes** - Global shipping and logistics
+- 🏛️ **Economic Indicators** - Central bank and government data
+- 🌍 **Geopolitical Analysis** - Global risk assessment
+- 🔄 **WebSocket Integration** - Real-time data streaming
-## USAGE
+</td>
+</tr>
+</table>
+</div>
-COMMAND TO START THE TERMINAL
+## 🚀 Installation
-```toml
-fincept # First Command to start the Terminal
+### **Option 1: Install via `pip` (Recommended)**
+```bash
+pip install fincept-terminal==1.0.10
```
-## UPCOMING FEATURS
+### **Option 2: Virtual Environment Setup**
+```bash
+# Create virtual environment
+python -m venv fincept-env
-- **Add Custom Data Sources**
-- **Common Analysis Tool for all data**
-- **RealTime Data (Web-Sockets)**
-- **Top Economy Data Sources**
-- **Customize Terminal Settings**
-- **General Optimizations**
-- **Country Specific Data**
-- **Making AI Based Terminal**
+# Activate (Windows)
+fincept-env\Scripts\activate
+# Activate (macOS/Linux)
+source fincept-env/bin/activate
-### Become a Contributor (Developer) 🚀
+# Install Fincept Terminal
+pip install fincept-terminal==1.0.10
+```
+
+### **Option 3: Desktop App**
+[![Download for Windows](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/download-windows.svg)](http://product.fincept.in/FinceptTerminalV2Alpha.exe)
-We welcome contributions from everyone! Whether you're fixing bugs, adding new features, or improving documentation, **your help is valuable!**
+## 🎮 Usage
-📌 **Read the Contribution Guidelines:**
-Check out our [CONTRIBUTING.md](https://github.com/Fincept-Corporation/FinceptTerminal/blob/main/CONTRIBUTING.md) to learn how you can contribute to Fincept Terminal.
+### Launch the Terminal
+```bash
+fincept # Single command to launch the GUI
+```
-[//]: # (## Table of Contents)
+### Key Interface Modules
+- **📊 Dashboard** - Market overview and real-time data
+- **📈 Analytics** - Advanced correlation and technical analysis
+- **💰 Trading** - Live trading with broker integrations
+- **🤖 AI Assistant** - GenAI-powered investment insights
+- **📋 Portfolio** - Custom portfolio creation and management
+- **🔍 Scanner** - Real-time stock screening and alerts
+- **📰 Intelligence** - News feeds and market research
-[//]: # ()
-[//]: # (- [Code of Conduct]&#40;#code-of-conduct&#41;)
+## 🎬 Platform Preview
-[//]: # (- [How Can I as a User Contribute?]&#40;#how-can-i-contribute&#41;)
+<div align="center">
-[//]: # ( - [Reporting Bugs]&#40;#reporting-bugs&#41;)
+| Chat Module | Dashboard | Economy |
+|:-----------:|:---------:|:-------:|
+| ![Chat](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Chat.png) | ![Dashboard](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Dashboard.png) | ![Economy](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Economy.png) |
+| Interactive AI chat | Real-time market overview | Global economic indicators |
-[//]: # ( - [Suggesting Enhancements]&#40;#suggesting-enhancements&#41;)
+| Equity Research | Forum | Geopolitics |
+|:---------------:|:-----:|:-----------:|
+| ![Equity](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Equity.png) | ![Forum](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Forum.png) | ![Geopolitics](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Geopolitics.png) |
+| Comprehensive stock analysis | Community discussions | Global risk assessment |
-[//]: # ( - [Submitting Pull Requests]&#40;#submitting-pull-requests&#41;)
+| Global Trade | Markets | Trade Analysis |
+|:------------:|:-------:|:--------------:|
+| ![GlobalTrade](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/GlobalTrade.png) | ![Markets](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/Markets.png) | ![TradeAnalysis](https://raw.githubusercontent.com/Fincept-Corporation/FinceptTerminal/main/images/TradeAnalysis.png) |
+| International trade flows | Live market data | Advanced trade analytics |
-[//]: # (- [Style Guides]&#40;#style-guides&#41;)
+</div>
-[//]: # ( - [Coding Standards]&#40;#coding-standards&#41;)
+## 🔥 Upcoming Features
-[//]: # ( - [Commit Messages]&#40;#commit-messages&#41;)
+### **🚀 Next Release (Q2 2024)**
+- ✅ **Custom Data Sources** - Integrate your preferred providers
+- ✅ **Enhanced AI Terminal** - More intelligent market analysis
+- ✅ **Real-Time WebSockets** - Ultra-fast data streaming
+- ✅ **Economy Data Hub** - Comprehensive economic indicators
+- ✅ **Terminal Customization** - Personalized workspace layouts
-[//]: # (- [Additional Resources]&#40;#additional-resources&#41;)
+### **🎯 Future Roadmap**
+- 🌍 **Country-Specific Data** - Localized market insights
+- ⚡ **Performance Optimizations** - Faster analysis and rendering
+- 📱 **Mobile Companion** - Cross-platform synchronization
+- 🏢 **Enterprise Features** - Team collaboration tools
+## 🤝 Become a Contributor
-### Create a GitHub Ticket
+**Join our mission to democratize financial analysis!** 🚀
-If you encounter any issues or have suggestions, feel free to create a GitHub ticket. Before submitting, please ensure the ticket doesn't already exist by searching through the existing [issues](https://github.com/fincept/fincept-terminal/issues).
+### 🎯 **How to Contribute**
+- 🐛 **Report Bugs** - Help us improve stability
+- 💡 **Suggest Features** - Share your ideas for new tools
+- 🔧 **Submit Code** - Contribute to our open-source platform
+- 📚 **Improve Docs** - Help others learn and use the platform
-- **[Report a bug](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new?template=bug_report.md)**: Found a bug? Let us know!
-- **[Suggest an improvement](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new?template=improvement.md)**: Have an idea to enhance the terminal? Share it with us!
-- **[Request a feature](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new?template=feature_request.md)**: Got a feature request? We’re listening!
+### 📋 **Quick Links**
+- 📖 [**Contributing Guidelines**](https://github.com/Fincept-Corporation/FinceptTerminal/blob/main/CONTRIBUTING.md)
+- 🐛 [**Report a Bug**](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new?template=bug_report.md)
+- ✨ [**Request Feature**](https://github.com/Fincept-Corporation/FinceptTerminal/issues/new?template=feature_request.md)
+- 💬 [**Discussions**](https://github.com/Fincept-Corporation/FinceptTerminal/discussions)
+## 📈 Star History
-## Star History
-**PLEASE STAR ⭐ THE REPO AND SHARE THE PROJECT ❤️‍🩹**
+**⭐ STAR THE REPO AND SHARE THE PROJECT ❤️**
+<div align="center">
<a href="https://star-history.com/#Fincept-Corporation/FinceptTerminal&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Fincept-Corporation/FinceptTerminal&type=Date&theme=dark" />
@@ -127,14 +176,27 @@ If you encounter any issues or have suggestions, feel free to create a GitHub ti
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Fincept-Corporation/FinceptTerminal&type=Date" />
</picture>
</a>
+</div>
+
+## 🌐 Connect With Us
+
+<div align="center">
+### 💬 **Community & Support**
-📌 **Join the Community:**
-- Discuss ideas and improvements in [GitHub Discussions](https://github.com/Fincept-Corporation/FinceptTerminal/discussions)
-- Report bugs in [GitHub Issues](https://github.com/Fincept-Corporation/FinceptTerminal/issues)
-- Connect with us via email at [[email protected]](mailto:[email protected])
+[![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-181717?style=for-the-badge&logo=github)](https://github.com/Fincept-Corporation/FinceptTerminal/discussions)
+[![Email Support](https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=gmail&logoColor=white)](mailto:[email protected])
+[![Contact Form](https://img.shields.io/badge/Contact-Form-4285F4?style=for-the-badge&logo=google&logoColor=white)](https://forms.gle/DUsDHwxBNRVstYMi6)
+
+### 🚀 **Get Started Today**
+
+[**📥 Download Desktop App**](https://github.com/Fincept-Corporation/FinceptTerminal/releases/download/Production1.0.0/FinceptInvestmentsInstaller.exe) • [**📦 Install via pip**](#-installation) • [**📖 Read Docs**](https://github.com/Fincept-Corporation/FinceptTerminal/wiki)
+
+---
+**Built by the community, for the community**
+*Making professional financial analysis accessible to everyone*
-Have questions or feedback? Facing issues? Fill out our contact form:
-[Google Form: Contact Us](https://forms.gle/DUsDHwxBNRVstYMi6)
+⭐ **Star us** • 🔄 **Share with colleagues** • 🤝 **Contribute today**
+</div>
\ No newline at end of file