From 6b131c3c43fe1a652104f9e904dc6e802d3eb371 Mon Sep 17 00:00:00 2001 From: Megan Chiovaro Date: Mon, 8 Jul 2024 14:50:14 -0400 Subject: [PATCH] Update README --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 55033ca..00f80b1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,23 @@ --- title: StockAIdvisor -emoji: 🏃 -colorFrom: yellow +emoji: 💸 +colorFrom: blue colorTo: green sdk: docker pinned: false ---- \ No newline at end of file +--- + +# StockAIdvisor + +_An app for stock identification and assessment using Claude._ + +**StockAIdvisor** is a tool for assessing stocks based on the previous years performance. Users can enter descriptions of the type of company they'd like to invest in. Claude will identify the company that they are most likely referring to (or that with the largest market cap) and return the ticker. The ticker is then used to collect performance data from `yfinance` and calculate various performance metrics. These metrics are then fed to Claude again to evaluate the stock's viability as a current investment choice based on risk tolerance. + +## Instructions +Navigate to the [Stock AIdvisor on Huggingface Spaces](https://huggingface.co/spaces/mchiovaro/stock-aidvisor) to give it a try. + +_This costs $$ to run! Please be mindful of others so that there are enough credits to go around. If there appear to be no more credits, feel free to send a message._ + +## Contributions +Feel free to submit a pull request for any issues or improvements! \ +Author: Megan Chiovaro (@mchiovaro) \ No newline at end of file