Update the docs - Githubissues

felipenoris / hyper-reverse-proxy

A simple reverse proxy for use with Hyper and Tokio

Apache License 2.0

181 stars 63 forks source link

Update the docs #36

Open felipenoris opened 2 years ago

felipenoris commented 2 years ago

[ ] rewrite docs main page with new examples
[ ] static client
[ ] ws support
[ ] notes on security
[ ] sync README.md with main page docs

somehowchris commented 2 years ago

Do yu mean the docs inside lib.rs?

felipenoris commented 2 years ago

@somehowchris , yes, the doc strings that generate https://docs.rs/hyper-reverse-proxy/latest/hyper_reverse_proxy/ and README.md which is a summary of the docs.

somehowchris commented 2 years ago

So #45 would include your points 1, 2, 4 & 5 inside the README.md and inside the mod doc, what kind of doc would you suggest for your point ws support. Just mentioning it?

somehowchris commented 2 years ago

@felipenoris So what's needed for a next release?

somehowchris commented 2 years ago

Hey @felipenoris,

It just makes me sad seeing such a lovely crate being unmaintained, people are loving it and opening up PRs to suggest awesome things. Do you plan to maintain it? If you need help, would love to chime in