-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,25 @@ | ||
# Inertia.js Preact Adapter | ||
<div align="center"> | ||
<img src="https://github.com/StouderIO/inertia-preact/assets/2575182/3171a67c-b971-483a-8448-92f9a6f55c6a.png" /> | ||
<h3>@stouder-io/inertia-preact</h3> | ||
<p>The <a href="https://preactjs.com/">Preact</a> adapter for <a href="https://inertiajs.com/">Inertia.js</a>.</p> | ||
<a href="https://www.npmjs.com/package/@stouder-io/inertia-preact"> | ||
<img src="https://img.shields.io/npm/v/@stouder-io/inertia-preact.svg?style=for-the-badge&logo=npm" /> | ||
</a> | ||
<img src="https://img.shields.io/npm/l/@stouder-io/inertia-preact?color=blueviolet&style=for-the-badge" /> | ||
<img alt="npm" src="https://img.shields.io/npm/dt/@stouder-io/inertia-preact?style=for-the-badge"> | ||
</div> | ||
|
||
The [Preact](https://preactjs.com/) adapter for [Inertia.js](https://inertiajs.com/). | ||
> This is a port of the original [Inertia.js React adapter](https://github.com/inertiajs/inertia/tree/master/packages/react) | ||
## Credits | ||
This is a port of the original [Inertia.js React adapter](https://github.com/inertiajs/inertia/tree/master/packages/react). | ||
|
||
Thanks to [jrson](https://jrson.me) for having released [an adapter for older release](https://github.com/jrson83/inertia-preact) of Inertia which is now archived. | ||
|
||
## Installation | ||
This package is available in the npm registry. | ||
|
||
## Install | ||
Install the adapter as any other NPM module: | ||
``` | ||
npm install @stouder-io/inertia-preact | ||
pnpm install @stouder-io/inertia-preact | ||
``` | ||
|
||
## Setup | ||
Inertia-wise, the adapter is interoperable with Inertia.js React adapter, setup should be the same. | ||
## Usage | ||
Inertia-wise, the adapter is interoperable with Inertia.js React adapter, setup should be exactly the same. |