Skip to content

Commit

Permalink
fix: readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
cofin committed Nov 30, 2024
1 parent 74ebc4d commit f5c35f5
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ on:
push:
branches:
- main
tags:
- v*.*.*
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand Down
30 changes: 19 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
================
Litestar Aiosql
================
=============
Litestar Vite
=============

Litestar Aiosql is a plugin to make managing and creating database sessions easier for Litestar applications.
Supercharge your Litestar applications with Vite's modern frontend tooling. Litestar-Vite seamlessly integrates
`Vite <https://vitejs.dev/>`_ - the next generation frontend build tool - with your Litestar web applications.

If you are using SQLAlchemy, you most likely want to use the SQLAlchemy Plugin. However, if you are not using an ORM or need a simple tool to manage `asyncpg` connections, this plugin is for you.

.. seealso:: It is built on:
Key Features
------------

* `SQLAlchemy <https://www.sqlalchemy.org/>`_
* `msgspec <https://jcristharif.com/msgspec/>`_
* `Alembic <https://alembic.sqlalchemy.org/en/latest/>`_
* `Typing Extensions <https://typing-extensions.readthedocs.io/en/latest/>`_
- 🚀 **Lightning-fast HMR**: Get instant feedback with Vite's blazing fast Hot Module Replacement
- 🔧 **Zero Config**: Works out of the box with sensible defaults
- 🎯 **Asset Management**: Automatically serves your static files and handles asset manifests
- 🛠️ **Development Mode**: Integrated dev server with automatic proxy configuration
- 📦 **Production Ready**: Optimized asset serving for production builds

Installation
------------
Expand All @@ -28,6 +29,13 @@ Installing ``litestar-vite`` is as easy as calling your favorite Python package
python3 -m pip install litestar-vite
.. tab-item:: uv

.. code-block:: bash
:caption: Using `uv <https://astral.sh/uv/>`_
uv add litestar-vite
.. tab-item:: pdm

.. code-block:: bash
Expand Down

0 comments on commit f5c35f5

Please sign in to comment.