Update README.md

This commit is contained in:
Michael Lazar 2019-08-04 22:57:34 -04:00 committed by GitHub
parent cc3a7b1a9c
commit 33a303ef7f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 0 deletions

View File

@ -0,0 +1,31 @@
# Jetforce
A python server framework for the new, under development Gemini Protocol.
Learn more about Project Gemini from its author, ~solderpunk, [here](https://gopher.commons.host/gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini).
## Features
- A modern Python 3 codebase with type hinting and black formatting.
- Lightweight, single-file web framework with zero dependencies.
- A built-in static file server with support for *.gemini* directory map files.
- 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.
## Installation
Requires Python 3.6+ and OpenSSL
### pip
```bash
$ pip install jetforce
```
### git
```bash
$ git clone https://github.com/michael-lazar/jetforce
$ cd jetforce
$ python jetforce.py
```