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

Binary usage documentation #13

Closed
khionu opened this issue Mar 3, 2018 · 6 comments
Closed

Binary usage documentation #13

khionu opened this issue Mar 3, 2018 · 6 comments
Assignees

Comments

@khionu
Copy link
Contributor

khionu commented Mar 3, 2018

If there isn't already documentation for using this as a binary, that is definitely necessary. Not everyone who could use this program for their own use will know how to program. Personally, I don't want to read source code to figure out CLI usage.

If there is documentation for this, it's not linked anywhere I can see

@bradfitz
Copy link
Collaborator

bradfitz commented Mar 5, 2018

I see documentation at:

https://github.com/google/tcpproxy/tree/master/cmd/tlsrouter

Is that not sufficient?

@khionu
Copy link
Contributor Author

khionu commented Mar 6, 2018

That is, very much so. That said, it's not linked anywhere. I can open a PR for the README.

bradfitz pushed a commit that referenced this issue Mar 6, 2018
Link to docs from the top level README.

Fixes #13
@khionu
Copy link
Contributor Author

khionu commented Mar 6, 2018

👍

@danderson
Copy link
Member

Thank you for the PR!

@khionu
Copy link
Contributor Author

khionu commented Mar 8, 2018

My pleasure. Happy to contribute where I can.

@micw
Copy link

micw commented Jan 12, 2019

Hi, I have seen that there's some ACME stuff - and nothing about it in the README. Could you please point out what it does?
Best regards,
Michael.

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

4 participants