From b459b211eedffb00d530e20880f3ee65e072e632 Mon Sep 17 00:00:00 2001 From: Xavier Stouder Date: Tue, 26 Dec 2023 02:41:07 +0100 Subject: [PATCH] fix: update readme --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c00e7a8..9e35c1b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,25 @@ -# Inertia.js Preact Adapter +
+ +

@stouder-io/inertia-preact

+

The Preact adapter for Inertia.js.

+ + + + + npm +
-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. \ No newline at end of file +## Usage +Inertia-wise, the adapter is interoperable with Inertia.js React adapter, setup should be exactly the same.