adzerk-oss / boot-cljs-repl

Boot task providing a REPL for ClojureScript development.
Eclipse Public License 1.0
72 stars 28 forks source link

Add emphasis to `start-repl` line #54

Open ghost opened 7 years ago

ghost commented 7 years ago

It's actually really easy to miss the start-repl line, and once you get connected, the REPL looks like it's been brought up successfully.

martinklepsch commented 7 years ago

I'd rather (or in addition possibly) see the start-repl note in the Usage section emphasized. I guess many people will just read this section and miss the (start-repl) call...

Have you read the documentation where you made changes before and it wasn't clear that running (start-repl) is required?

ghost commented 7 years ago

That was actually how I ran into this problem. Somehow it is possible to miss it.

I considered adding a short paragraph explaining how the client needs to start a server on its side and connect to the websocket URL provided by the nREPL server, but I thought it might have been too long. What do you think?