Update README.md

12 months ago · 248d668715
parent 20b6ca41d6
commit 248d668715
1 changed files with 30 additions and 13 deletions
--- a/README.md
+++ b/README.md
@ -1,12 +1,16 @@
 <img src="https://github.com/beucismis/ozgursozluk/assets/40023234/4f145030-2376-4d2d-acb0-39167212793f" width="380">

 ![](https://img.shields.io/badge/python-3.8%2B-blue)
+![](https://img.shields.io/pypi/v/ozgursozluk)
+![](https://img.shields.io/pypi/dm/ozgursozluk)
 ![](https://img.shields.io/badge/code%20style-black-black)
-![](https://img.shields.io/github/v/release/beucismis/ozgursozluk)
 ![](https://img.shields.io/github/actions/workflow/status/beucismis/ozgursozluk/tests.yml?label=tests)
+![](https://img.shields.io/github/actions/workflow/status/beucismis/ozgursozluk/publish.yml?label=publish)

 A free and open source alternative ekşi sözlük front-end. Does not use the API, only scrapes the web. Official instance: https://ozgursozluk.freedns.rocks

+Donate: https://ozgursozluk.freedns.rocks/donate
+
 ## Features
 - No JavaScript
 - Docker support
@ -18,35 +22,48 @@ A free and open source alternative ekşi sözlük front-end. Does not use the AP
 - Self-hosted, ad-free, simple and fast
 - Responsive support for small screens

-## Installing and Running
-Clone the repository:
+## Installation
+Install from the `pip`:
 ```
-git clone https://github.com/beucismis/ozgursozluk
-cd ozgursozluk/
+pip3 install ozgursozluk
 ```
-
-Normal running:
+Install from the repo:
 ```
-pip3 install -r requirements.txt
-gunicorn
+pip3 install git+https://github.com/beucismis/ozgursozluk.git
 ```
-Deploy using a different port: `gunicorn --bind 127.0.0.1:3131`
-
-Running with Docker:
+Updating:
 ```
+pip3 install ozgursozluk --upgrade
+```
+Alternatively, with Docker:
+```
+git clone https://github.com/beucismis/ozgursozluk
+cd ozgursozluk
 docker build -t ozgursozluk .
 docker run -p 3131:80 ozgursozluk
 ```

+## Usage
+```
+flask --app ozgursozluk run
+# or
+gunicorn ozgursozluk:app
+```
 See also, https://github.com/beucismis/ozgursozluk/wiki/Main

 ### Environment Variables
-
 | Key | Type | Default Value |
 | - | - | - |
 | `SECRET_KEY` | `str` |  |
 | `EKSI_SOZLUK_BASE_URL` | `str` | `https://eksisozluk1923.com` |

+Flask:
+| Key | Type | Default Value |
+| - | - | - |
+| `FLASK_RUN_HOST` | `str` | `127.0.0.1` |
+| `FLASK_RUN_PORT` | `str` | `5000` |
+
+
 ## Redirection
 [Redirector](https://einaregilsson.com/redirector) browser extension is recommended for use. Configuration:
 ```