update readme
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Jeffrey Paul 2020-09-30 01:39:19 -07:00
parent d3e6e7fd32
commit 80c2a9c39c
1 changed files with 43 additions and 10 deletions

View File

@ -2,27 +2,60 @@
[![Build Status](https://drone.datavi.be/api/badges/sneak/gohttpserver/status.svg)](https://drone.datavi.be/sneak/gohttpserver)
This is my boilerplate for starting a new go HTTP server repository.
This is my boilerplate for a go HTTP server, designed to be a
starting point template for new projects.
Many ideas are taken from Mat Ryer's talk How I Write HTTP Web Services
after Eight Years at GopherCon 2019, seen here:
Many ideas are taken from Mat Ryer's talk titled "How I Write HTTP Web Services
after Eight Years" at GopherCon 2019, seen here:
https://www.youtube.com/watch?v=rWBSMsLG8po
# Contributing
Contributions are welcome! Please send me an email if you'd like an account
on this server to submit PRs.
Alternately, even just feedback is great:
[sneak@sneak.berlin](mailto:sneak@sneak.berlin)
# Features
* Basic logging middleware
* Stub Authentication middleware
* Helper functions for encoding/decoding json
* Healthcheck route
* No global state
# TODO
* Database Boilerplate
* Logging Middleware
* Authentication Middleware Stub
* sync.Once example for precompiling templates
* Bundling Static Assets Into Binary
* Dockerization
* Metrics Endpoint / Request Statistic Aggregation
# Author
sneak@sneak.berlin
https://sneak.berlin
* [sneak@sneak.berlin](mailto:sneak@sneak.berlin)
* https://sneak.berlin
* [@sneak@sneak.berlin](https://s.sneak.berlin/@sneak)
# License
WTFPL
WTFPL (aka public domain):
```
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
```