Merge pull request #14 from andreped/readme-refactor

Added CI table to README; hyperlinks to section titles

README.md

@@ -11,7 +11,7 @@ license: mit
 app_file: app.py
 ---
 
-# chatbot-streamlit-demo
+# [chatbot-streamlit-demo](https://github.com/andreped/chatbot-streamlit-demo#chatbot-streamlit-demo)
 
 [![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 <a target="_blank" href="https://huggingface.co/spaces/andreped/chatbot-streamlit-demo"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
@@ -24,19 +24,27 @@ The final app is also deployed on both [Streamlit](https://chatbot-app-demo.stre
 
 The ChatBot enables you to talk with your own data - in this case, to learn about [André's research](https://scholar.google.com/citations?user=U20zUHQAAAAJ).
 
-## Demo
+## [Continuous integration](https://github.com/andreped/chatbot-streamlit-demo#continuous-integration)
+
+| Build Type | Status |
+| - | - |
+| **HF Deploy** | [![Deploy](https://github.com/andreped/chatbot-streamlit-demo/workflows/Deploy/badge.svg)](https://github.com/andreped/chatbot-streamlit-demo/actions) |
+| **File size check** | [![Filesize](https://github.com/andreped/chatbot-streamlit-demo/workflows/Check%20file%20size/badge.svg)](https://github.com/andreped/chatbot-streamlit-demo/actions) |
+| **Linting** | [![Filesize](https://github.com/andreped/chatbot-streamlit-demo/workflows/Check%20formatting/badge.svg)](https://github.com/andreped/chatbot-streamlit-demo/actions) |
+
+## [Demo](https://github.com/andreped/chatbot-streamlit-demo#demo)
 
 We have enabled live hosting through both Streamlit and Hugging Face spaces. Click on the respective badges below to access each:
 
-#### Hugging Face Spaces <a target="_blank" href="https://huggingface.co/spaces/andreped/chatbot-streamlit-demo"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
+#### [Hugging Face Spaces](https://github.com/andreped/chatbot-streamlit-demo#hugging-face-spaces) <a target="_blank" href="https://huggingface.co/spaces/andreped/chatbot-streamlit-demo"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
 
 ![Screenshot 2023-10-24 at 13 44 15](https://github.com/andreped/chatbot-streamlit-demo/assets/29090665/610ed8f1-39e9-4842-ab5b-93847678812c)
 
-#### Streamlit [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://chatbot-app-demo.streamlit.app)
+#### [Streamlit](https://github.com/andreped/chatbot-streamlit-demo#Streamlit) [![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://chatbot-app-demo.streamlit.app)
 
 ![Screenshot 2023-10-24 at 13 03 11](https://github.com/andreped/chatbot-streamlit-demo/assets/29090665/ba82787a-71fc-4d6c-9ae0-c11417df2841)
 
-## Development
+## [Development](https://github.com/andreped/chatbot-streamlit-demo#Development)
 
 If you wish to play around with the app locally, it requires that you provide OpenAI API key and all that fun stuff yourself.
 
@@ -66,14 +74,14 @@ streamlit run app.py
 
 A Streamlit browser window should automatically open. If not, the app can be accessed at `http://localhost:8501`
 
-## Disclaimer
+## [Disclaimer](https://github.com/andreped/chatbot-streamlit-demo#disclaimer)
 
 Only public PDFs were used for this demonstration. Some of André's research is sadly behind a paywall and thus we have chosen not to include the PDFs in this demo to avoid copyright issues.
 
-## Acknowledgements
+## [Acknowledgements](https://github.com/andreped/chatbot-streamlit-demo#acknowledgements)
 
 I wish to thank [Sopra Steria](https://www.soprasteria.com) for giving me the chance to develop this web application on internal time. I also want to thank [OpenAI](https://openai.com), [Microsoft Azure](https://azure.microsoft.com/en-us), and the developers of [llama-index](https://www.llamaindex.ai), [Streamlit](https://streamlit.io), and [HuggingFace](https://huggingface.co) for making such great tools to make applications in.
 
-## License
+## [License](https://github.com/andreped/chatbot-streamlit-demo#license)
 
 The code in this repository is released under [MIT license](https://github.com/andreped/chatbot-streamlit-demo/blob/main/LICENSE).