youngmonkeys / ezyfox-server

A socket server (include SSL) supports realtime application, realtime game, MMORPG, messaging, chat and streaming data with TCP, UDP and Websocket
Apache License 2.0
569 stars 98 forks source link

Restructure README #115

Closed trungdlp-wolffun closed 1 year ago

trungdlp-wolffun commented 1 year ago

What is the purpose of this pull request?

I want to restructure README to focus core value of this repository

When do you want to merge?

A about 1 a week

Could you please review/proofread my work? Visit this page

TrungKenbi commented 1 year ago

@tvd12, please take a look 🙇

tvd12 commented 1 year ago

@vu-luong do you like this readme style? Take a look here for preview

trungdlp-wolffun commented 1 year ago

@tvd12 I think we need add example for Maven and Gradle user to install EzyFox, like this:

image
tvd12 commented 1 year ago

@tvd12 I think we need add example for Maven and Gradle user to install EzyFox, like this:

image

Let me think, but I don't prefer it, because ezyfox server is difference from netty, it has multi components and have some way to create a project and start coding, one of way you can refer here: https://youngmonkeys.org/ezyfox-server/guides/create-ezyfox-server-project.

And I think we should keep README is simple and linking to the details document is more suitable.

TrungKenbi commented 1 year ago

@vu-luong thank for you suggestion, I updated. cc @tvd12

TrungKenbi commented 1 year ago

@vu-luong I updated. We should add demo code section?

tvd12 commented 1 year ago

No, we don't need it anymore

tvd12 commented 1 year ago

~@trungdlp-wolffun @TrungKenbi I don't want to justify center the README content because I think people look form left to right, so I want to justify left, how do you think?~ sorry my bad.

TrungKenbi commented 1 year ago

@tvd12 Hmm, I just center only image content and people love at the first sight when see great image.

tvd12 commented 1 year ago

@vu-luong I will merge it after you approve

trungdlp-wolffun commented 1 year ago

@tvd12, @vu-luong, I already updated all suggestions. Please take a look one last time.

We are building an awesome project, and I hope many people can see and love this project ❤️ Many thanks!