deepstream.io-client-js icon indicating copy to clipboard operation
deepstream.io-client-js copied to clipboard

Update README.md

Open slachtar opened this issue 5 years ago • 4 comments

new users, need a straight code to test deepstream on the browser, this is a copy/past code to test deepstream.

slachtar avatar Sep 16 '20 16:09 slachtar

Hi, wouldn't it be simpler to just link to the getting started page on the Documentation section of this readme ? Since there is no use for the client without a server to connect to.

jaime-ez avatar Sep 17 '20 13:09 jaime-ez

Personnaly, I like code snippest when they are in the readme, so no need to use navigate outside. I think we need to add a section:

Before you start

We assume that you have already installed deepstream server as a standalone server or as a node module https://deepstream.io/tutorials/install/linux/

slachtar avatar Sep 17 '20 14:09 slachtar

I agree that for many projects it is useful to have a quick start right on the readme. Maye we could do as they do on the socket.io repos. They have a "How to use" section with short snippets to get started. I'll be ok with having that section both in the client and server repos. If you agree, could you push an update to this pull?

jaime-ez avatar Sep 18 '20 23:09 jaime-ez

Yes, sure I'll make necessary changes and let you know.

On Sat, Sep 19, 2020 at 12:57 AM jaime echegaray zipper < [email protected]> wrote:

I agree that for many projects it is useful to have a quick start right on the readme. Maye we could do as they do on the socket.io repos. They have a "How to use" section with short snippets to get started. I'll be ok with having that section both in the client and server repos. If you agree, could you push an update to this pull?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/deepstreamIO/deepstream.io-client-js/pull/543#issuecomment-695132092, or unsubscribe https://github.com/notifications/unsubscribe-auth/AATKH2Q5G34DXIESFNVPLIDSGPXWRANCNFSM4RPDUBEA .

-- Slah Lachtar Tel. (+216) 98 221 575

slachtar avatar Sep 19 '20 10:09 slachtar