diff --git a/README.md b/README.md index b02a5ff..121e08d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ via [Fastify](https://github.com/fastify/fastify). [![npm](https://img.shields.io/npm/v/@applicazza/fastify-nextjs)](https://www.npmjs.com/package/@applicazza/fastify-nextjs) [![codecov](https://codecov.io/gh/applicazza/fastify-nextjs/branch/main/graph/badge.svg?token=CCVDPRT9MT)](https://codecov.io/gh/applicazza/fastify-nextjs) + +**This project is yet to reach stable state. You may help by contributing and testing it.** + +## Why + +Original [fastify-nextjs](https://github.com/fastify/fastify-nextjs) doesn't pass response through Fastify's pipeline thus hooks that you may need won't work. This package is using JavaScript's [Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) to intercept calls to NodeJs [http.ServerResponse](https://nodejs.org/api/http.html#http_class_http_serverresponse) and pass it to Fastify. + ## Usage Add dependencies diff --git a/package.json b/package.json index d2d2b3a..7f54d9e 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "name": "Artyom Sokolov", "url": "https://artyomsokolov.com" }, + "description": "Fastify and Next.js integration", "devDependencies": { "@types/eslint": "^7", "@types/jest": "^26.0.23", @@ -29,6 +30,13 @@ "files": [ "dist" ], + "homepage": "https://github.com/applicazza/fastify-nextjs", + "keywords": [ + "fastify", + "next", + "react", + "ssr" + ], "license": "MIT", "main": "dist/index.js", "name": "@applicazza/fastify-nextjs", @@ -44,5 +52,5 @@ "test": "jest --coverage" }, "types": "dist/index.d.ts", - "version": "0.0.2" + "version": "0.0.3" }