waldek
/
jetforce
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Michael Lazar 2019-08-23 23:29:18 -04:00 committed by GitHub
parent bab0056bfe
commit 7a608e4d48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -23,45 +23,24 @@
## Features ## Features
Jetforce comes with two components:
- A modern python codebase with type hinting and black formatting. - A modern python codebase with type hinting and black formatting.
- A built-in static file server with support for gemini directory files. - A built-in static file server with support for gemini directory files.
- Lightweight, single-file framework with zero dependencies. - Lightweight, single-file framework with zero dependencies.
- Supports concurrent connections using an asynchronous event loop. - Supports concurrent connections using an asynchronous event loop.
- Extendable - loosely implements the [WSGI](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) server/application pattern. - Extendable - loosely implements the [WSGI](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) server/application pattern.
## Demo
A live demonstration of the Jetforce server is available on gemini at the following URL:
---
<p align="center">
<b><a href="gemini://mozz.us">gemini://mozz.us</a></b><br>
</p>
---
## Installation ## Installation
Requires Python 3.7+ and OpenSSL Requires Python 3.7+ and OpenSSL. The latest release of Jetforce can be downloaded from [PyPI](https://pypi.org/project/Jetforce/):
### pip
```bash ```bash
$ pip install jetforce $ pip install jetforce
``` ```
### git Or, you can download the repository and run the script directly:
```bash ```bash
$ git clone https://github.com/michael-lazar/jetforce $ git clone https://github.com/michael-lazar/jetforce
$ cd jetforce $ cd jetforce
$ python jetforce.py $ ./jetforce.py
``` ```
## TODO
- Finish documentation :)