README in go-shrt

at master

1Shrt
2====
3
4This is a URL shortener. There are many like it, but this is mine. Try
5putting all the vowels in "shrt" and enjoy yourself!
6
7Also handles go-get redirects.
8
9HTTP Handler
10------------
11
12This Go http.Handler module is imported as djmo.ch/go-shrt.
13
14To use, initialize Shrt with a shrt.Config objec. Drop this Handler
15into your site's http.ServeMux and start serving shortlinks and go-get
16redirects.
17
18CLI Reference Implementation
19----------------------------
20
21The command line interface (CLI) in this repository is useful if you
22wish to run Shrt as a standalone server. It can is installed in the
23usual manner:
24
25 $ go install djmo.ch/go-shrt/cmd/shrt@latest
26
27From there you can run "shrt help" to read the CLI documentation.
28
29License
30-------
31
32ISC. See the LICNSE file for full copyright and license details.