excaliburjs / Excalibur

🎮 Your friendly TypeScript 2D game engine for the web 🗡️
https://excaliburjs.com
BSD 2-Clause "Simplified" License
1.83k stars 192 forks source link

It is NOT clear that Excalibur is client-side only from the docs #391

Closed eonarheim closed 9 years ago

eonarheim commented 9 years ago

There has been some recent confusion about how to install and run node due to the npm package we have. We probably need to make clear in the docs that this package is only meant as another form of distribution (see https://www.npmjs.com/package/jquery). Even so, the presence of a client-side npm package sort of runs against the theory of npm.

I think there are 2 options here:

Thoughts anyone?

kamranayub commented 9 years ago

I vote removing in favor of bower... it's clear bower is meant for front-end libraries while npm was designed for node packages.

eonarheim commented 9 years ago

@kamranayub I'd be willing to remove it, but it does remove a deployment mechanism. On the other had we only need to support 2 from now on... @jedeen @alanag13 your thoughts?

jedeen commented 9 years ago

I'd be fine with removing it, especially if it will help prevent this sort of confusion in the future. On Apr 4, 2015 8:58 AM, "Erik Onarheim" notifications@github.com wrote:

@kamranayub https://github.com/kamranayub I'd be willing to remove it, but it does remove a deployment mechanism. On the other had we only need to support 2 from now on... @jedeen https://github.com/jedeen @alanag13 https://github.com/alanag13 your thoughts?

— Reply to this email directly or view it on GitHub https://github.com/excaliburjs/Excalibur/issues/391#issuecomment-89582077 .

alanag13 commented 9 years ago

I agree, given that this is js and such I could see how this would be very misleading

eonarheim commented 9 years ago

We have deprecated the npm package and removed the npm install directions from our documentation