-
-
Notifications
You must be signed in to change notification settings - Fork 60
Documentation and examples for advanced usage #66
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
Conversation
README.md
Outdated
@@ -92,6 +93,31 @@ $dns = $factory->createCached('8.8.8.8', $loop, $cache); | |||
|
|||
See also the wiki for possible [cache implementations](https://github.com/reactphp/react/wiki/Users#cache-implementations). | |||
|
|||
## Advanced Usage | |||
|
|||
For more advanced usages one can utilize the `Executor` directly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm planning to deprecate the Executor
in future versions, so perhaps we should link to the whole namespace instead (may keep the below example in place though)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deprecating executor seems to be a good idea.
README.md
Outdated
@@ -13,6 +13,7 @@ easily be used to create a DNS server. | |||
* [Basic usage](#basic-usage) | |||
* [Caching](#caching) | |||
* [Custom cache adapter](#custom-cache-adapter) | |||
* [Advanced usage](#advance-usage) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor typo here, otherwise LGTM 👍
Changes LGTM, unrelated build error has been addressed via #68 in the meantime |
Currently once can use the
Executor
directly to query but this isn't documented. This PR adds documentation and an example.