Create README.md

README.md

@@ -1,13 +1,28 @@
 ---
 title: Sentiment3D
-emoji: 🌖
-colorFrom: gray
-colorTo: indigo
+emoji: 📊
+colorFrom: yellow
+colorTo: green
 sdk: gradio
-sdk_version: 3.40.1
+sdk_version: 3.35.2
 app_file: app.py
 pinned: false
 license: cc-by-4.0
 ---
+# COMPASS Pathways Three-dimensional Sentiment Model
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+<div align="center">
+
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/compasspathways/Sentiment3D/blob/main/.pre-commit-config.yaml)
+[![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
+
+A package for computing the three-dimensional sentiment scores and a Jupyter notebook for replicating the analysis described in the paper "[From a Large Language Model to Three-Dimensional Sentiment](https://psyarxiv.com/kaeqy/)".
+
+</div>
+
+
+
+## Citation
+
+Please cite our paper titled "From a Large Language Model to Three-Dimensional Sentiment". ([preprint](https://psyarxiv.com/kaeqy/))