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

Improve documentation for sample application CLI tools #1316

Closed
ian-kelling opened this issue Apr 4, 2017 · 3 comments
Closed

Improve documentation for sample application CLI tools #1316

ian-kelling opened this issue Apr 4, 2017 · 3 comments
Labels
Milestone

Comments

@ian-kelling
Copy link
Contributor

ian-kelling commented Apr 4, 2017

What is an app in this context? This is the next section after running the daemon, it reads like this is the next and required step for using the pump.io server, is it? What does the app name signify? What possible values can it be? It says "the credentials file", as if the reader is supposed to know what that means or what it's used for, but they don't. What is the purpose of credentials here? Then it says "the clientID", what is that? It needs an explanation.

The command line documentation has contradicting documentation:

Usage: /usr/bin/nodejs ./bin/pump-register-app -t title -e email [-w|-n]

The cli documentation seems to imply that port might be an important argument.

I tried some variations and got failures:

./bin/pump-register-app  -t web -e root@localhost -p 8000
SyntaxError: Unexpected token < in JSON at position 0
    at Object.parse (native)
    at Function.<anonymous> (/home/ian/pump.io/bin/pump-register-app:80:25)
    at next (/home/ian/pump.io/node_modules/step/lib/step.js:51:23)
    at IncomingMessage.<anonymous> (/home/ian/pump.io/lib/pumpclient.js:141:13)
    at emitNone (events.js:91:20)
    at IncomingMessage.emit (events.js:185:7)
    at endReadableNT (_stream_readable.js:974:12)
    at _combinedTickCallback (internal/process/next_tick.js:80:11)
    at process._tickCallback (internal/process/next_tick.js:104:9)
@strugee
Copy link
Member

strugee commented Apr 4, 2017

Good question. Basically pump-register-app registers a client app for use with the pump server. Normally if you use a client like e.g. Dianara or Pumpa it will do this for you. The commandline tools in this repo are basically intended to be examples of applications.

That being said they're probably somewhat busted, as you're finding out. I'll push a fix to the README to make it less confusing and leave your issues open as something to fix in the future - but don't hold your breath. Thus far there have been more pressing things in the core, and that'll probably continue to be the case for a while.

Thanks for checking out pump :)

@strugee strugee added the docs label Apr 4, 2017
@strugee strugee changed the title pump-register-app is missing vital documentation details Improve documentation for sample application CLI tools Apr 4, 2017
@strugee strugee added this to the Future milestone Apr 4, 2017
@strugee
Copy link
Member

strugee commented Apr 4, 2017

See also #1200

strugee added a commit that referenced this issue Apr 4, 2017
@strugee
Copy link
Member

strugee commented Nov 30, 2017

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

No branches or pull requests

2 participants