Skip to content

Commit

Permalink
docs: Update REAMDE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paveldedik committed Jun 28, 2024
1 parent d31c755 commit 93e5546
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,10 @@ Here is a table comparing Ludic to other similar tools:
| HTML rendering | Server Side | Client Side | Client Side |
| Uses a template engine | No | No | No |
| UI interactivity | [</> htmx](https://htmx.org)* | [React](https://react.dev/) | [React](https://react.dev/) |
| Backend framework | [Starlette](https://www.starlette.io)* | [FastAPI](https://fastapi.tiangolo.com) | [FastAPI](https://fastapi.tiangolo.com) |
| Backend framework | [Starlette](https://www.starlette.io), [Django](https://www.djangoproject.com/)* | [FastAPI](https://fastapi.tiangolo.com) | [FastAPI](https://fastapi.tiangolo.com) |
| Client-Server Communication | [HTML + REST](https://htmx.org/essays/how-did-rest-come-to-mean-the-opposite-of-rest/) | [JSON + REST](https://github.com/pydantic/FastUI?tab=readme-ov-file#the-principle-long-version) | [WebSockets](https://reflex.dev/blog/2024-03-21-reflex-architecture/) |

<sup>(*) HTMX as well as Starlette are optional dependencies for Ludic, it does not enforce any frontend or backend frameworks. At it's core, Ludic only generates HTML and allows registering CSS.</sup>

## Quick Demo

<p align="center">
<img width="600px" src="https://raw.githubusercontent.com/getludic/ludic/main/docs/assets/quick-demo.gif" alt="Quick Demo">
</p>
<sup>(*) HTMX as well as Starlette or Django are optional dependencies for Ludic, it does not enforce any frontend or backend frameworks. At it's core, Ludic only generates HTML and allows registering CSS.</sup>

## Motivation

Expand Down Expand Up @@ -161,6 +155,13 @@ To run the application:
uvicorn web:app
```

### Integrations

Here is a list of integrations and a link to the guide on how to get started:

* [Starlette](https://getludic.dev/docs/web-framework)
* [Django](https://getludic.dev/docs/integrations#django)

### More Examples

For more complex usage incorporating all capabilities of the framework, please visit the examples on [the web](https://getludic.dev/examples) or go to the folder with examples [on GitHub](https://github.com/getludic/ludic/tree/master/examples/).
Expand Down

0 comments on commit 93e5546

Please sign in to comment.