From 0afc64d121af21e8fa147acfc8419297a0a81d22 Mon Sep 17 00:00:00 2001 From: tv Date: Mon, 6 Jan 2014 00:02:01 +0100 Subject: go: README looks like markdown --- go/README.markdown | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 go/README.markdown (limited to 'go/README.markdown') diff --git a/go/README.markdown b/go/README.markdown new file mode 100644 index 00000000..17deb7d6 --- /dev/null +++ b/go/README.markdown @@ -0,0 +1,27 @@ +go - minimalistic uri shortener + +# installation + npm install + + optionally + npm install hiredis + +# run service + HOSTN=go PORT=80 node . + + if you omit `HOSTN`, then relative shortened uris will be generated. + +# add uri + curl -F uri=https://mywaytoolonguri http://go + + this will give you a shortened uri. + +# resolve uri + + curl -L http://go/1 + +# clear database + + redis-cli keys 'go:*' | xargs redis-cli del + + if you have changed `redisPrefix`, then use that instead of `go:`. -- cgit v1.2.3 From c6386b16b5fe69abe284bd4c658fe286394e631a Mon Sep 17 00:00:00 2001 From: tv Date: Mon, 6 Jan 2014 00:04:42 +0100 Subject: go: make README look like markdown harder --- go/README.markdown | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) (limited to 'go/README.markdown') diff --git a/go/README.markdown b/go/README.markdown index 17deb7d6..d3088685 100644 --- a/go/README.markdown +++ b/go/README.markdown @@ -1,26 +1,32 @@ -go - minimalistic uri shortener +# go - minimalistic uri shortener + +## install dependencies -# installation npm install - optionally + apparently you can also + npm install hiredis -# run service + for more awesome. + +## run service + HOSTN=go PORT=80 node . if you omit `HOSTN`, then relative shortened uris will be generated. -# add uri +## add uri + curl -F uri=https://mywaytoolonguri http://go this will give you a shortened uri. -# resolve uri +## resolve uri - curl -L http://go/1 + curl -L http://go/1 -# clear database +## clear database redis-cli keys 'go:*' | xargs redis-cli del -- cgit v1.2.3 From eec4484676565be3384fde82f8fcbc71f1fe0ffe Mon Sep 17 00:00:00 2001 From: tv Date: Mon, 6 Jan 2014 00:06:20 +0100 Subject: go: talk about default port --- go/README.markdown | 1 + 1 file changed, 1 insertion(+) (limited to 'go/README.markdown') diff --git a/go/README.markdown b/go/README.markdown index d3088685..11a31975 100644 --- a/go/README.markdown +++ b/go/README.markdown @@ -15,6 +15,7 @@ HOSTN=go PORT=80 node . if you omit `HOSTN`, then relative shortened uris will be generated. + if you omit `PORT`, then it's `1337`. ## add uri -- cgit v1.2.3