Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mistakes in documentation #48

Closed
marti1125 opened this issue Nov 10, 2013 · 8 comments
Closed

Mistakes in documentation #48

marti1125 opened this issue Nov 10, 2013 · 8 comments

Comments

@marti1125
Copy link

In https://github.com/incompl/cloak/wiki/GettingStarted

in this part, when I copy and paste this

{
  name: 'My Cool Game'
}

and then run: npm install cloak --save

npm ERR! Failed to parse json
npm ERR! Unexpected token }
npm ERR! File: C:\Users\User\Documents\GitHub\multiplayer\package.json
npm ERR! Failed to parse package.json data.
npm ERR! package.json must be actual JSON, not just JavaScript.
npm ERR!
npm ERR! This is not a bug in npm.
npm ERR! Tell the package author to fix their package.json file. JSON.parse

I had to change with

 {
     "name": "MyCoolGame"
 }

there are some links broken like:

https://github.com/incompl/cloak/tree/master/example

@aychtang
Copy link
Collaborator

Will fix up and improve docs on tuesday.

@marti1125
Copy link
Author

ok, thanks :)

@incompl
Copy link
Owner

incompl commented Nov 11, 2013

I got it, thanks for reporting these!

@incompl incompl closed this as completed Nov 11, 2013
@dirkk0
Copy link

dirkk0 commented Nov 25, 2013

One error persisted: the name "My Cool Game" is still an 'invalid name'.
Blanks seem to be not allowed so you have to write "MyCoolGame" as @marti1125 suggested.

@incompl
Copy link
Owner

incompl commented Nov 25, 2013

@dirkk0 I could not reproduce this. Further, there is no code that validates room names. Can you provide some code that demonstrates the problem and open a new ticket with it?

@dirkk0
Copy link

dirkk0 commented Nov 26, 2013

@incompl sure I can, but I guess I just put that wrong maybe:

On the 'Getting started' page in the 'Server' section the author suggest to call the game 'My Cool Game' in the file package.json. This seems to be a non-valid name to npm. It has nothing to do with room names, only with the name of the project in package.json.

@marti1125
Copy link
Author

use this :)

{
"name": "MyCoolGame"
}

@incompl
Copy link
Owner

incompl commented Nov 26, 2013

Oops no idea how I misread this. Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants