Merge pull request #3 from benjamin-awd/update-docs

Update docs

README.md

@@ -1 +1,15 @@
-This repository deploys Monopoly to Streamlit
+# About
+This repository deploys [Monopoly](https://github.com/benjamin-awd/monopoly) as a webapp and an offline, desktop application.
+
+The desktop version of the application can be downloaded from the [releases](https://github.com/benjamin-awd/monopoly-streamlit/releases) page.
+
+<h3 align="center">
+    🎉 Monopoly is now live! 🎉
+    <br><br>
+    Try it out: <br>
+    <a href="https://monopoly.streamlitapp.com/">https://monopoly.streamlitapp.com/</a>
+</h3>
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/benjamin-awd/monopoly-streamlit/main/docs/streamlit_demo.gif" width=800>
+</p>

pages/about.py

@@ -4,11 +4,12 @@
 st.markdown("# About")
 
 st.markdown(
-    """Monopoly is a Python library that converts Singapore bank statement PDFs to CSV using pdftotext.
+    "[![Release](https://img.shields.io/github/v/release/benjamin-awd/monopoly-streamlit)]"
+    "(https://github.com/benjamin-awd/monopoly-streamlit/releases)"
+)
 
-I started this project because I wanted to have a simple and convenient way of comparing all of my transactions
-across multiple banks each month.
-"""
+st.markdown(
+    """Monopoly is a Python library that converts bank statement PDFs to CSV using pdftotext."""
 )
 
 st.markdown(
@@ -79,7 +80,7 @@
 Despite all the security measures listed above, uploading sensitive data to the internet always comes with a risk.
 
 With that in mind, here are some measures for a better security posture:
-- Use the [offline](https://github.com/benjamin-awd/monopoly) version of Monopoly
+- Use the monopoly [CLI](https://github.com/benjamin-awd/monopoly), or the [offline](https://github.com/benjamin-awd/monopoly-streamlit/releases) version of the app
 - Redact any sensitive information in transactions e.g. card numbers, names etc.
 - Change the default password of your bank statement PDFs (i.e. not NRIC/DOB)
 """

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "monopoly-streamlit"
-version = "0.9.2"
-description = ""
+version = "0.9.2-rc.1"
+description = "Streamlit deployment of Monopoly"
 authors = ["Benjamin Dornel <[email protected]>"]
 readme = "README.md"