Update README.md

pull/12/head
beucismis 1 year ago
parent 0dadf11d43
commit 0e681fb624
  1. 27
      README.md

@ -9,10 +9,11 @@
A free and open source alternative ekşi sözlük front-end. Does not use the API, only scrapes the web. 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 Official instance: https://ozgursozluk.freedns.rocks</br>
Donate: https://ozgursozluk.freedns.rocks/donate Donate: https://ozgursozluk.freedns.rocks/donate
## Features ## Features
- No JavaScript - No JavaScript
- Docker support - Docker support
- Topic searching - Topic searching
@ -24,35 +25,42 @@ Donate: https://ozgursozluk.freedns.rocks/donate
- Responsive support for small screens - Responsive support for small screens
## Installation ## Installation
Install from the `pip`: Install from the `pip`:
``` ```
pip3 install ozgursozluk pip3 install ozgursozluk
``` ```
Install from the repo: Install from the repo:
``` ```
pip3 install git+https://github.com/beucismis/ozgursozluk.git pip3 install git+https://github.com/beucismis/ozgursozluk.git
``` ```
Updating: Updating:
``` ```
pip3 install ozgursozluk --upgrade pip3 install ozgursozluk --upgrade
``` ```
## Deploying
```
flask --app ozgursozluk run
# or
gunicorn ozgursozluk:app
```
Alternatively, with Docker: Alternatively, with Docker:
``` ```
git clone https://github.com/beucismis/ozgursozluk git clone https://github.com/beucismis/ozgursozluk
cd ozgursozluk cd ozgursozluk
docker build -t ozgursozluk . docker build -t ozgursozluk .
docker run -p 3131:80 ozgursozluk docker run -p 8080:80 ozgursozluk
``` ```
## Usage
```
flask --app ozgursozluk run
# or
gunicorn ozgursozluk:app
```
See also, https://github.com/beucismis/ozgursozluk/wiki/Main See also, https://github.com/beucismis/ozgursozluk/wiki/Main
## Environment Variables ## Environment Variables
| Key | Type | Default Value | | Key | Type | Default Value |
| - | - | - | | - | - | - |
| `SECRET_KEY` | `str` | | | `SECRET_KEY` | `str` | |
@ -61,6 +69,7 @@ See also, https://github.com/beucismis/ozgursozluk/wiki/Main
| `EKSI_SOZLUK_BASE_URL` | `str` | `https://eksisozluk1923.com` | | `EKSI_SOZLUK_BASE_URL` | `str` | `https://eksisozluk1923.com` |
## Redirection ## Redirection
[Redirector](https://einaregilsson.com/redirector) browser extension is recommended for use. Configuration: [Redirector](https://einaregilsson.com/redirector) browser extension is recommended for use. Configuration:
``` ```
Description: ekşi sözlük to özgürsözlük Description: ekşi sözlük to özgürsözlük
@ -72,6 +81,7 @@ Example result: https://ozgursozluk.freedns.rocks/linux--32084
``` ```
## Preview ## Preview
<table> <table>
<tbody> <tbody>
<tr> <tr>
@ -83,4 +93,5 @@ Example result: https://ozgursozluk.freedns.rocks/linux--32084
</table> </table>
## License ## License
This project is licensed under WTFPL for details, check [LICENSE](LICENSE) file. This project is licensed under WTFPL for details, check [LICENSE](LICENSE) file.

Loading…
Cancel
Save