Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Ingram committed Feb 10, 2022
1 parent 5edfe3c commit 3f0c381
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,31 @@ the need of having a separate files for view functions and templates. It tries
to embrace [Locality of Behaviour](https://htmx.org/essays/locality-of-behaviour/)
by putting the view function code and template in the same file, and having the
file's path be the route used by Starlette to access the code.

## Installation

```
pip install darkstar
```

You can then run the included CLI with:

```
python -m darkstar create-app --help
```

To run your new app, you'll need an ASGI server installed, such a Hypercorn, Daphne, or Uvicorn.

To run with Uvicorn, first install it:

```
python -m pip install uvicorn[standard]
```

The run your app:

```
python -m uvicorn app:app
```

(This assumes your defined your app as the `app` variable in an `app.py` file.)
2 changes: 1 addition & 1 deletion src/darkstar/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
A web framework for using htmx with Starlette
"""

__version__ = "0.1.2.post1"
__version__ = "0.1.3"

0 comments on commit 3f0c381

Please sign in to comment.