Skip to content

Commit

Permalink
add tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
0x67757300 committed Dec 15, 2023
1 parent 7a7a0d9 commit 3e2d050
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 11 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,19 @@ if __name__ == '__main__':
uvicorn.run('__main__:app')
```

### API Reference
### Documentation

[Here.](https://0x67757300.github.io/uHTTP/uhttp.html)
First, you should read the [tutorial](https://github.com/0x67757300/uHTTP-Tutorial). It will show you how to write and deploy a link aggregation platform (read: Hacker News clone).

### Tutorial
Then, take look at the [API reference](https://0x67757300.github.io/uHTTP/uhttp.html).

_Coming soon..._
Finally, enjoy the source code. ;)

### Extensions

µHTTP doesn't come with bells and whistles.
_µHTTP doesn't come with bells and whistles._

If you want more, search for [µHTTP extensions](https://github.com/topics/uhttp).

If what you want isn't available, consider writing your own extension.
If you want more, search for [µHTTP extensions](https://github.com/topics/uhttp). No luck? Write your own?!

### Contributing

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "uHTTP"
version = "1.3.1"
version = "1.3.2"
description = "Pythonic web development"
authors = ["gus <[email protected]>"]
license = "MIT"
Expand Down
3 changes: 1 addition & 2 deletions uhttp.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def mount(self, app, prefix=''):
The lifespan and middleware functions are appended. The routes
are set at the prefix. The max_content is a max between both
app's.
apps.
E.g.:
Expand Down Expand Up @@ -99,7 +99,6 @@ def auth(request):
if request.headers.get('from') not in request.state['db']:
raise Response(401)
@app.route('/')
def profile(request):
...
Expand Down

0 comments on commit 3e2d050

Please sign in to comment.