diff --git a/README.md b/README.md index 29b0508..99b4914 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,25 @@ app_file: app.py # Postly +[![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/andreped/postly/blob/main/LICENSE.md) + + This repository contain the Postly client, which serves as a micro-message communication platform, similar to Twitter. -## Getting started +To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app. -Implemented client requires only Python >=3.7, no additional requirements. +Screenshot + +## Getting started -To use client, simply do something like this: +Install dependencies: +``` +pip install -r requirements.txt ``` -from postly.clients import PostlyClient -postly_instance = PostlyClient() +Run streamlit app: +``` +streamlit run app.py ``` ## Testing @@ -34,6 +42,8 @@ For this project, we perform continuous integration to make sure that code is te | Build Type | Status | | - | - | | **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Tests/badge.svg)](https://github.com/andreped/postly/actions) | +| **Check file size** | [![CI](https://github.com/andreped/postly/workflows/Check%20file%20size/badge.svg)](https://github.com/andreped/postly/actions) | +| **Unit tests** | [![CI](https://github.com/andreped/postly/workflows/Deploy/badge.svg)](https://github.com/andreped/postly/actions) | To perform unit tests, you need to install `pytest`. For running formatting checks you also need `flake8`, `isort`, and `black`. We also depend on `pydantic` for type validation. To do so, lets configure a virtual environment: ``` diff --git a/assets/streamlit-app-demo.png b/assets/streamlit-app-demo.png new file mode 100644 index 0000000..362d093 Binary files /dev/null and b/assets/streamlit-app-demo.png differ