moost 0.0.1-beta.5 → 0.2.0

package/README.md

@@ -1,10 +1,10 @@
-# Moost
+# moost
 
 **!!! This is work-in-progress library, breaking changes are expected !!!**
 
 <p align="center">
-<img src="./docs/moost_composite_icon.png" width="370px"><br>
-<a  href="https://github.com/prostojs/moost/blob/main/LICENSE">
+<img src="../../moost-logo.png" width="450px"><br>
+<a  href="https://github.com/moostjs/moostjs/blob/main/LICENSE">
     <img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" />
 </a>
 </p>
@@ -13,7 +13,7 @@ Moost is a Metadata driven Web App Framework inspired by [nestjs](https://nestjs
 
 The main ideas behind Moost are:
 1. Use the power of TS decorators to describe your app
-2. Use the power of [wooks](https://github.com/wooksjs/wooks) to process http requests
+2. Use the power of [wooks](https://github.com/wooksjs/wooks) to process events
 3. Make it easier to control dependency injections
 4. Use as less external dependencies as possible
 
@@ -22,13 +22,16 @@ What's the difference to [nestjs](https://nestjs.com/)?
 2. It utilizes reusable dependency injection framework [@prostojs/infact](https://github.com/prostojs/infact)
 3. It uses metadata layer powered by [@prostojs/mate](https://github.com/prostojs/mate)
 4. It supports DTOs and validations powered by [@prostojs/valido](https://github.com/prostojs/valido)
-5. It does not use express or fastify
+5. It does not use express or fastify (although you can use express/fastify with an adapter)
 6. Currently it does not support any of additional techniques (like ORMs, Queues etc.)
 
 ## Quick Start
 
+### An example with [@moostjs/event-http](https://github.com/moostjs/moostjs/tree/main/packages/event-http) adapter
+
 ```ts
-import { Moost, Get, Param } from 'moost'
+import { MoostHttp, Get } from '@moostjs/event-http'
+import { Moost, Param } from 'moost'
 
 class MyServer extends Moost {
     @Get('test/:name')
@@ -37,13 +40,16 @@ class MyServer extends Moost {
     }
 }
 
-new MyServer().listen(3000)
+const app = new MyServer()
+const http = new MoostHttp()
+app.adapter(http).listen(3000, () => { console.log('Up on port 3000') })
+app.init()
 // curl http://localhost:3000/test/World
 // {"message":"Hello World!"}
 ```
 
 ## Install
 
-`npm install moost`
+`npm install moost @moostjs/event-http`
 
 ## To be Documented...