(WIP) Docs: Update readme #18
Merged
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
|
I'll add my suggestions in a review so we can further discuss the wording ! |
Gandem
reviewed
Feb 16, 2018
README.md
Outdated
| @@ -1,5 +1,13 @@ | |||
| # bonjour-reflector | |||
|
|
|||
| ## About this project | |||
|
|
|||
| This projects aims to make bonjour devices (such as printers, chromecasts, ...) discoverable and usable by other devices located in different VLANs. | |||
There was a problem hiding this comment.
I'd add something about how this is similar to avahi-reflector, but in addition permits a fine-grained control of how Bonjour traffic is reflected between VLANs.
README.md
Outdated
|
|
||
| This projects aims to make bonjour devices (such as printers, chromecasts, ...) discoverable and usable by other devices located in different VLANs. | ||
|
|
||
| This is done by intercepting mDNS packets and forwarding them to the correct VLANs (for the request packets, the VLANs where the bonjour devices are located; for the response packets, the VLANs where the searching devices are located). |
There was a problem hiding this comment.
Let's split this in bullet points to make it clearer maybe ?
There was a problem hiding this comment.
Should we also add a sentence about how this interception is done ? (the bonjour-reflector should have on interface with all the concerned vlans on tagged for example)
|
I reorganized a few bits in the README. Feel free to discuss these changes if you think the README could be improved :) |
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.
@oxlay @Gandem could you help me with wording / rephrasing for better clarity?