chore: Update socketio example

tsedio · Jun 9, 2019 · 03176c0 · 03176c0
1 parent 15a1c0d
commit 03176c0
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 7 deletions.
diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md
@@ -13,7 +13,7 @@ Some examples are available along these links :
 
 - [Basic usages](https://github.com/TypedProject/tsed-getting-started)
 - [Https](https://github.com/TypedProject/example-ts-express-decorator/tree/4.0.0/example-https)
-- [A SquareGame with SocketIO](https://github.com/TypedProject/ts-express-decorators/tree/production/integration/socketio)
+- [A SquareGame with SocketIO](https://github.com/TypedProject/tsed-example-socketio)
 - [Authentication with Passport.js](https://github.com/TypedProject/example-ts-express-decorator/tree/4.0.0/example-passport)
 - [Mongoose](https://github.com/TypedProject/tsed-example-mongoose)
 - [TypeORM](https://github.com/TypedProject/tsed-example-typeorm)

diff --git a/docs/tutorials/socket-io.md b/docs/tutorials/socket-io.md
@@ -13,7 +13,7 @@ Socket.io enable real-time bidirectional event-based communication. It works on
 
 ## Example
 
-A complete example is available [here](https://github.com/TypedProject/ts-express-decorators/tree/production/integration/socketio).
+A complete example is available [here](https://github.com/TypedProject/tsed-example-socketio).
 
 ## Installation
 

diff --git a/integration/socketio/readme.md b/integration/socketio/readme.md
@@ -1,17 +1,58 @@
 # Ts.ED - SocketIO
 
-Here an example with TS.ED and SocketIO. The application it's a Multiplayer game which use websocket to connect different clients together.  
+Here an example to configure your server and how to create your first controller.
+
+See [Ts.ED](https://tsed.io) project for more information.
+
+## Checkout
+
+This repository provide getting started project example for each Ts.ED version since `v5.18.1`.
+
+```bash
+git checkout -b https://github.com/TypedProject/tsed-example-socketio/tree/v5.18.1
+```
+
+To checkout another version just replace `v5.18.1` by the desired version.
 
 ## Install
 
-> **Important!** Ts.ED requires Node >= 6, Express >= 4 and TypeScript >= 2.7.
+> **Important!** Ts.ED requires Node >= 8, Express >= 4 and TypeScript >= 3.
 
 ```batch
-yarn install
+npm install
 ```
 
 ## Run
 
 ```
-yarn start
+npm start
 ```
+
+## Contributing
+
+You can make a PR directly on https://github.com/TypedProject/ts-express-decorators repository.
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
+
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2019 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[travis]: https://travis-ci.org/
diff --git a/integration/typeorm/readme.md b/integration/typeorm/readme.md
@@ -1,4 +1,4 @@
-# Ts.ED - Getting started
+# Ts.ED - TypeORM
 
 Here an example to configure your server and how to create your first controller.
 

diff --git a/repo.config.js b/repo.config.js
@@ -37,6 +37,9 @@ module.exports = {
     },
     "typeorm": {
       url: "https://github.com/TypedProject/tsed-example-typeorm.git"
+    },
+    "socketio": {
+      url: "https://github.com/TypedProject/tsed-example-socketio.git"
     }
   },
   tsdoc: {