Skip to content
This repository has been archived by the owner on Mar 31, 2020. It is now read-only.

Commit

Permalink
Remove package descriptions from README
Browse files Browse the repository at this point in the history
As package descriptions are automatically generated by GoDoc, there is
not need to maintain a separate set of descriptions for our packages.
Therefore, the README is being updated to show only examples.
  • Loading branch information
abeltay committed Feb 2, 2018
1 parent b265293 commit d999fc3
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,9 @@

This repository contains useful code that we use in our Go projects.

## Random
Random generates cryptographically random strings. This can be used to generate variables such as session IDs.
## Examples

## Web
### FileServer
FileServer creates a file server that serves files from from a "Root" folder. It will call "NotFound" HandlerFunc if the path contains '..' or if the file cannot be found on the system

### Server
Server extends the default HTTP server with graceful shutdown on receiving `SIGINT` or `SIGTERM`. The web server is a 1 to 1 replacement of http.Server's `ListenAndServe()`.

Example code:
### web.Server
```
import (
"log"
Expand Down

0 comments on commit d999fc3

Please sign in to comment.