Skip to content

Commit 5493d22

Browse files
~readme
1 parent 1cc6836 commit 5493d22

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
11
# Super Fast HTTP2 Framework for Progressive Web Application
22

3-
4-
# Dependency
5-
Python3.5+
6-
Future version might only support Python3.6+ since `curio` might only support 3.6+ in the future.
7-
```bash
8-
pip install h2
9-
pip install curio
3+
# Installation
4+
Clone this project to your local directory. In this directory,
5+
```
6+
python setup.py
107
```
11-
I will make it available on pip once I have the first release.
8+
This will automatically install `hyper2web` to the associated Python as a site-package.
9+
10+
I will make it available on PyPi once I have the first release.
11+
12+
## Python Version
13+
Python3.5+
14+
15+
## Dependency
16+
This project uses `h2` and `curio`.
1217

13-
This project is at its very early stage. I still need to learn a lot about h2, curio, HTTP and Web.
1418
[h2 Github](https://github.com/python-hyper/hyper-h2) [doc](https://python-hyper.org/h2/en/stable/)
1519
[curio Github](https://github.com/dabeaz/curio) [doc](https://curio.readthedocs.io/en/latest/)
1620

1721
# How to
18-
First clone this repo to your disk.
19-
20-
Under this repo, create a dir `public` or whatever names, put your frontend code there.
21-
22-
Then create an `app.py` or whatever names.
22+
Assuming you have a directory structure like
23+
```
24+
your project/
25+
--public/
26+
--index.html
27+
--index.js
28+
...
29+
--app.py
30+
```
31+
Your `app.py` looks like
2332
```python
2433
from hyper2web import app
2534

0 commit comments

Comments
 (0)