Here’s the updated README.md with the requested changes, including the development status and the removal of code examples:
This project provides an adapter for using the high-performance HyperExpress framework as the platform driver for a NestJS application. It allows you to benefit from HyperExpress' ultra-fast server while keeping all the benefits of the NestJS framework.
Inspired by nest-hyper-express
Status: This package is currently in development and not available on npm yet. You can clone the repository and test it locally.
- Use HyperExpress as the HTTP server for your NestJS project, optimizing performance.
- Support for both HTTP and WebSocket connections.
- Lightweight and optimized for high concurrency and low memory consumption.
- Compatible with NestJS middleware and dependency injection.
Since this package is still under development, you can install it directly from the repository:
# Clone the repository
git clone https://github.com/zenofolio/nestjs-hyper-express-platform.git
# Install dependencies
cd nestjs-hyper-express-platform
npm installThere is an example included in this repository that demonstrates how to use the adapter. To run the example:
cd example
npm install
npm run start- Full support for NestJS features (guards, interceptors, etc.).
- Optimizations for WebSocket connections.
- Publish the package to npm.
- Detailed documentation on configuration and usage.
Contributions are welcome! Feel free to create issues or submit pull requests to help improve this adapter. Check out the issues section for more information.
This project is licensed under the MIT License. See the LICENSE file for details.
This version reflects the development status and provides basic instructions without code examples. Let me know if you'd like any further adjustments!