Restore instructions for testing Electron

[dfabulich]

In #98 I added instructions for testing Electron; these were removed in commit 5437383. I assume that was an accident? Here's a PR to restore the instructions.

[dfabulich]

Can we merge this?

[ceifa]

Idk if we should keep getting the maintainers documentation bigger and not growing the consumer one. I would like to keep it as small as possible, so people don't think they have to clone the repository or build things by themselfs to make steamworks.js work.

This part specifically it's kinda obvious for experienced developers that the tests are in "test" directory.

[dfabulich]

it's kinda obvious for experienced developers that the tests are in "test" directory

I've been a developer for more than 20 years; I've been using steamworks.js since September of last year. I really struggled to get it to work at first. I had no idea that there was a checked-in Electron project in the test folder. I thought the tests were all CLI unit tests.

The whole time I've been watching this project on Github, the project continues to get a steady trickle of folks writing in, saying "WTF this project doesn't work at all". e.g. #111. I'm sure that the developers there are experienced developers, but I was nonetheless able to provide value to them by pointing out that there's a sample Electron project in the test folder.

That Electron "test" isn't just a test; it's the example project. I think it would be a big help to refer to it clearly in the documentation, so people would know that they can start with the example, get it working, and then make changes to it as they work. It would also help people to file better bugs, with clear "to reproduce" instructions, instead of "it's not working on my Electron app which I can't actually share with you."

I claim that linking to the example would have helped with #12, #23, #50, #63, #65, #67, #75, #94, #99, #111, #112.

Idk if we should keep getting the maintainers documentation bigger and not growing the consumer one.

I'm not sure I understand the distinction you're drawing here between "maintainers documentation" and "consumer documentation." My understanding is that README.md is the only documentation for steamworks.js, other than the client.d.ts declarations file.

So, as far as I know, README.md is the only place to tell people "hey, did you know we have an example Electron project, and it's supposed to just work, out of the box?"

[ceifa]

fair