Add a blub to README about running YACE as a library #34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kgeckhart
requested review from
cristiangreco,
thepalbi,
IfSentient,
ferruvich and
matthewnolf
matthewnolf
approved these changes
Apr 12, 2022
README.md
Outdated
| ### Embedding YACE as a library in an existing application | ||
| It is possible to embed YACE in to an existing library to scrape on demand. This might be useful to you would like to scrape on demand or run in a stateless manner. | ||
|
|
||
| The entrypoint to use YACE as a library is [update.go](./pkg/update.go) which requires, |
There was a problem hiding this comment.
Maybe worth mentioning the entrypoint func, rather than file name (or both?)
There was a problem hiding this comment.
A link to GoDoc here may also be nice
There was a problem hiding this comment.
A link to GoDoc here may also be nice
Good call, I should probably add a GoDoc as well
kgeckhart
force-pushed
the
keckhart/library-readme
branch
from
a0d8d07
to
311140c
Compare
kgeckhart
force-pushed
the
keckhart/library-readme
branch
from
311140c
to
dbbc462
Compare
ferruvich
approved these changes
Apr 13, 2022
|
Thanks for the feedback, upstream PR is open nerdswords#560, I'll close this and will sync it with upstream when it comes through. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looking for some feedback on this before I submit it upstream with the metric registration changes. I'm not always the best at writing coherent docs.