andreped commited on
Commit
2c07cde
·
1 Parent(s): 02b3c9a

Added streamlit snapshot; updated getting started section in README

Browse files
Files changed (1) hide show
  1. README.md +8 -5
README.md CHANGED
@@ -16,15 +16,18 @@ app_file: app.py
16
 
17
  This repository contain the Postly client, which serves as a micro-message communication platform, similar to Twitter.
18
 
19
- ## Getting started
20
 
21
- Implemented client requires only Python >=3.7, no additional requirements.
22
 
23
- To use client, simply do something like this:
 
 
24
  ```
25
- from postly.clients import PostlyClient
26
 
27
- postly_instance = PostlyClient()
 
 
28
  ```
29
 
30
  ## Testing
 
16
 
17
  This repository contain the Postly client, which serves as a micro-message communication platform, similar to Twitter.
18
 
19
+ <img width="1400" alt="Screenshot 2023-10-31 at 01 34 47" src="https://github.com/andreped/assets/postly_image.png">
20
 
21
+ ## Getting started
22
 
23
+ Install dependencies:
24
+ ```
25
+ pip install -r requirements.txt
26
  ```
 
27
 
28
+ Run streamlit app:
29
+ ```
30
+ streamlit run app.py
31
  ```
32
 
33
  ## Testing