docs: add changelog for v0.1.0

Author: attilaorosz

CHANGELOG.md

@@ -2,6 +2,124 @@
 
 _This changelog follows the [keep a changelog][keep-a-changelog]_ format to maintain a human readable changelog.
 
+
+## [0.1.0](https://github.com/typestack/socket-controllers/compare/v0.0.5...v0.1.0) (2023-01-18)
+
+### Breaking Changes
+
+- Removed `createSocketServer()` in favor of constructor initialization 
+
+  BEFORE:
+
+  ```ts
+  import { useSocketServer } from 'socket-controllers';
+  import { Server } from 'socket.io';
+
+  const io = new Server(PORT);
+  useSocketServer(io);
+  ```
+
+  AFTER:
+
+  ```ts
+  import { SocketControllers } from "socket-controllers";
+  import { Server } from "socket.io";
+
+  const io = new Server(PORT);
+  new SocketControllers({io: io, container: YOUR_DI_CONTAINER});
+  ```
+- Removed `createSocketServer()` in favor of constructor initialization 
+
+  BEFORE:
+
+  ```ts
+  import { createSocketServer } from 'socket-controllers';
+
+  const io = createSocketServer(PORT);
+  ```
+
+  AFTER:
+
+  ```ts
+  import { SocketControllers } from "socket-controllers";
+
+  const server = new SocketControllers({port: PORT, container: YOUR_DI_CONTAINER});
+  const io = server.io;
+  ```
+
+- Removed `useContainer()` in favor of constructor initialization
+
+  BEFORE:
+
+  ```ts
+  import { useContainer } from 'socket-controllers';
+  import { Container } from 'typedi';
+
+  useContainer(Container);
+  ```
+
+  AFTER:
+
+  ```ts
+  import { SocketControllers } from "socket-controllers";
+  import { Container } from 'typedi';
+
+  const server = new SocketControllers({port: PORT, container: Container});
+  ```
+  > Note: DI container is not included anymore, you have to provide your own.
+
+- Changed initialization parameters
+
+  Before:
+  ```typescript
+  interface SocketControllersOptions {
+    controllers?: Function[] | string[];
+    middlewares?: Function[] | string[];
+    useClassTransformer?: boolean;
+    classToPlainTransformOptions?: ClassTransformOptions;
+    plainToClassTransformOptions?: ClassTransformOptions;
+  }
+  ```
+
+  After:
+  ```typescript
+  interface SocketControllersOptions {
+    container: { get<T>(someClass: { new (...args: any[]): T } | Function): T };
+    io?: Server;
+    port?: number;
+    controllers?: Function[] | string[];
+    middlewares?: Function[] | string[];
+    transformOption?: Partial<{
+      transform?: boolean;
+      parameterTransformOptions?: ClassTransformOptions;
+      resultTransformOptions?: ClassTransformOptions;
+    }>;
+  }
+  ```
+
+- Changed class-transformer property name in decorators that support class-transformer
+
+  Before:
+  `classTransformOptions?: ClassTransformOptions`
+
+  After:
+  `transformOptions?: ClassTransformOptions`
+
+### Added
+- Namespace scope support for middlewares
+- `transport: boolean` option to decorators that support class-transformer
+
+### Changed
+
+- `class-transformer` package updated from `0.1.6` to `0.5.1`
+- `path-to-regexp` package updated from `3.0.0` to `6.2.1`
+- `reflect-metadata` package updated from `0.1.10` to `0.1.13`
+- `socket.io` package updated from `2.0.1` to `4.5.4`
+- updated various dev dependencies
+
+### Breaking changes
+
+
 ### [0.0.5][v0.0.5] - 2020-02-04
 
 #### Added