sandialabs / wiretap

Wiretap is a transparent, VPN-like proxy server that tunnels traffic via WireGuard and requires no special privileges to run.
Other
837 stars 37 forks source link

Split README into Wiki #56

Open Aptimex opened 4 weeks ago

Aptimex commented 4 weeks ago

The Readme is really long, would probably be more useful to have the different headings split into topics in a Wiki format.

luker983 commented 3 weeks ago

The docs could certainly be better organized. I tend to prefer a table of contents and Cmd+F rather than having to rely on a wiki search bar and jumping between pages though.

Moving the demo section to a Wiki page and linking to it from pretty high up in the existing readme would be a good first step I think.

Aptimex commented 3 weeks ago

ToC and some cleanup might be good enough. I'll get some additional internal feedback on user preferences before committing to the full Wiki idea.

Agreed that would be a good first step either way.