Skip to content
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

Add Usage documentation #10

Closed
thedrow opened this issue Nov 30, 2015 · 10 comments
Closed

Add Usage documentation #10

thedrow opened this issue Nov 30, 2015 · 10 comments

Comments

@thedrow
Copy link

thedrow commented Nov 30, 2015

Other than https://github.com/TechEmpower/FrameworkBenchmarks/pull/1765/files I don't see usage examples of this library.
A full tutorial will allow others to adopt this library more easily.

@valyala
Copy link
Owner

valyala commented Nov 30, 2015

Basic usage documentation must appear soon.

Thanks for the idea, @thedrow .

@valyala
Copy link
Owner

valyala commented Nov 30, 2015

There are some examples available in the documentation.

@valyala
Copy link
Owner

valyala commented Dec 1, 2015

Added switching from net/http to fasthttp section into README.

@abacaj
Copy link

abacaj commented Dec 2, 2015

Getting better with the docs / examples, maybe time to have a small dedicated site to fasthttp for better display of docs / examples, tools that come to mind - Hugo, Hexo, gitbook

@valyala
Copy link
Owner

valyala commented Dec 2, 2015

Yeah, this site will be created with github pages.

@abacaj
Copy link

abacaj commented Dec 2, 2015

@valyala if you need styling help for a theme or something similar, I can lend a hand - I was a front end dev for about a year.

@valyala
Copy link
Owner

valyala commented Dec 2, 2015

Cool! @abacaj , could you create initial site version using github pages under your account? Then I could review and publish it.
Currently I have no idea what contents this site should contain other than README.md :)

valyala added a commit that referenced this issue Dec 4, 2015
@valyala
Copy link
Owner

valyala commented Dec 7, 2015

Examples folder has been added.

@valyala
Copy link
Owner

valyala commented Dec 8, 2015

Added helloworldserver example.

Closing the bug, since it looks like documentation minimum has been reached.

@valyala valyala closed this as completed Dec 8, 2015
@thedrow
Copy link
Author

thedrow commented Dec 8, 2015

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants