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

Enable use as a library #12

Closed
joonas-fi opened this issue Mar 2, 2022 · 6 comments
Closed

Enable use as a library #12

joonas-fi opened this issue Mar 2, 2022 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@joonas-fi
Copy link
Contributor

It would be great to use rsync server as a library in other Go projects.

@stapelberg
Copy link
Contributor

Is this done with #11, or is there anything else you’re planning on doing before this issue should be closed? :)

@joonas-fi
Copy link
Contributor Author

Great question!

How about docs, should we just link to the PR for the code example? I have nothing else in mind. (That reminds me, the code example is outdated w.r.t. the module slice. I'll update it when I get back home.)

@stapelberg
Copy link
Contributor

Or maybe we add a minimal server example? Should only be a few lines of code :)

@joonas-fi
Copy link
Contributor Author

joonas-fi commented Mar 27, 2022

In README.md or as an example binary under cmd/?

@stapelberg
Copy link
Contributor

Ideally as a testable example that shows up in godoc and is verified to compile using go test: https://go.dev/blog/examples :)

@joonas-fi
Copy link
Contributor Author

lol thank you, once again I'm learning from you, I've spat out Go code for years but never learned about "testable examples" 😄

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

No branches or pull requests

2 participants