shyam gupta commited on
Commit
af8140d
·
unverified ·
1 Parent(s): 4db4bdc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -2
README.md CHANGED
@@ -1,2 +1,40 @@
1
- # CapiPort
2
- Building a Portfolio Optimization tool
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Portfolio Management for Indian Equity Markets
2
+
3
+ [![Build Status](your_build_status_badge_url)](your_build_status_page_url) [![Tests Passing](your_tests_passing_badge_url)](your_tests_page_url)
4
+
5
+ ## Overview
6
+
7
+ Welcome to our project on portfolio management for Indian equity markets! This project aims to help individuals efficiently allocate their money between different equities, optimizing returns while managing risk.
8
+
9
+ ## Features
10
+
11
+ - **Dynamic Allocation:** Our technique dynamically allocates funds among various equities based on a robust methodology.
12
+ - **Risk Management:** The project incorporates risk management strategies to enhance overall portfolio stability.
13
+ - **User-Friendly Interface:** Access the tool through our user-friendly web interface [here](https://capiport.streamlit.app/).
14
+
15
+ ## Getting Started
16
+
17
+ Follow these steps to get started with the project:
18
+
19
+ 1. Clone the repository:
20
+
21
+ ```bash
22
+ git clone https://github.com/your-username/your-repository.git
23
+
24
+ 2. Install dependencies:
25
+ ```bash
26
+ pip install -r requirements.txt
27
+
28
+ 3. Run the project:
29
+ ```bash
30
+ python main.py
31
+
32
+
33
+ #### Contributing
34
+
35
+ We welcome contributions! If you have any ideas for improvements, open an issue or submit a pull request.
36
+ License
37
+
38
+ This project is licensed under the MIT License.
39
+
40
+ Visit our live project: ![Portfolio Management Tool](https://capiport.streamlit.app/)