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

Add protocol/protocol-name docs and test #450

Merged
merged 7 commits into from
Aug 12, 2016
Merged

Conversation

kevinsawicki
Copy link
Contributor

Adds documentation and an initial test for the protocol/protocol-name option.

Closes #121

cause URLs such as `myapp://path` to be opened with the app. This option can be
specified multiple times to register multiple protocol schemes with the app.
Maps to the `CFBundleURLSchemes` metadata property. This argument requires
a corresponding `--protocol-name` argument.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is currently written more CLI-centric than API-centric (although it's a little too verbose for usage.txt). s/argument/option/g and remove the flag prefix from protocol-name.

@malept malept added the docs-needed 📝 Pull request needs documentation label Aug 12, 2016
@malept
Copy link
Member

malept commented Aug 12, 2016

Needs some docs in usage.txt.

@malept malept modified the milestone: 7.6.0 Aug 12, 2016
@kevinsawicki kevinsawicki removed the docs-needed 📝 Pull request needs documentation label Aug 12, 2016
@kevinsawicki
Copy link
Contributor Author

@malept I've updated usage.txt, thanks for the review 👍


*Array* of *String*s

The URL protocol scheme to associate the app with. Specifying `myapp` would
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL protocol scheme

scheme(s)

specified multiple times to register multiple protocol schemes with the app.
Maps to the `CFBundleURLSchemes` metadata property. This option requires
a corresponding `protocol-name` option to be specified.
The URL protocol scheme(s) to associate the app with. Specifying `myapp` would
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last thing, I swear:

For example, specifying myapp [...]

@malept malept merged commit c3145c1 into master Aug 12, 2016
@malept malept deleted the protocol-docs-and-tests branch August 12, 2016 20:43
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

Successfully merging this pull request may close these issues.

2 participants