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

Bring did-client README into docs.veres.one #5

Open
BigBlueHat opened this issue Mar 14, 2018 · 2 comments
Open

Bring did-client README into docs.veres.one #5

BigBlueHat opened this issue Mar 14, 2018 · 2 comments
Assignees

Comments

@BigBlueHat
Copy link

https://github.com/digitalbazaar/did-client#did-client

I was going to send a PR to tweak the current https://github.com/veres-one/docs.veres.one/blob/master/docs/developers/guides/create-did.md instructions (because the npm stuff doesn't work as there's no package.json created, etc). But I then found the did-client instructions--which are more complete and informational.

Not sure how best to sync/connect those two, but I'd recommend at least bringing a copy of the README over in place of the current npm install instructions (which currently don't work).

Cheers!
🎩

@mattcollier
Copy link
Contributor

Hello, yes, the documentation needs improvement and will be updated soon.

I would like to determine what sort of issue you had with the basic npm install instructions that you referenced. Node 8.94 and NPM v5.6 will install the module into the newly created did-client folder without there being an existing package.json file. Did you experience difficulty in this regard?

@mattcollier mattcollier self-assigned this Mar 14, 2018
@BigBlueHat
Copy link
Author

Node 8.8.1 & NPM 5.4.2 here. I'm actually blocked by a Python error thrown by node-gyp, atm. However, I did get (at one point) some message about needing a package.json file--which I added using the defaults (i.e. did-client) and then couldn't install did-client because of the name match.

Regardless of my personal error, it might be best to give the demo folder a different name so that it doesn't collide with the name of the actual client project. That way when devs go to contribute, they'll be able to checkout the did-client project alongside their test. 😄

Also, linking from the website/docs to the did-client project would be a win and the repo for the web site

Thanks!

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

No branches or pull requests

2 participants