Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
edsu committed Jun 19, 2017
1 parent 78a8b70 commit c07b4ba
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

[![Build Status](https://secure.travis-ci.org/edsu/unshrtn.png)](http://travis-ci.org/edsu/unshrtn)

unshrtn is a [LevelDB] backed URL unshortening microservice written in [Node]
for quick, asynchronous processing of requests. unshrtn remembers what it has
already looked up so it can save you the trouble of keeping track of URLs when
you are looking up a lot of them at one time and they haven't necessarily been
de-duplicated. unshrtn will also look for [canonical links] in HTML responses so
the unshortened URLs will have marketing tracking parameters removed.
unshrtn is a [LevelDB] backed URL unshortening microservice written in
[JavaScript] and [Node] for quick, asynchronous processing of requests. unshrtn
remembers what it has already looked up so it can save you the trouble of
keeping track of URLs when you are looking up a lot of them at one time and they
haven't necessarily been de-duplicated. unshrtn will also look for [canonical
links] in HTML responses so the unshortened URLs will have marketing tracking
parameters removed.

% curl http://localhost:3000?url=https://bitly.com/4kb77v
{
Expand Down Expand Up @@ -37,6 +38,7 @@ You can also install it with [npm]:
npm install -g unshrtn

[LevelDB]: https://code.google.com/p/leveldb/
[JavaScript]: https://en.wikipedia.org/wiki/JavaScript
[Node]: https://nodejs.org
[canonical links]: https://en.wikipedia.org/wiki/Canonical_link_element
[Docker]: https://www.docker.com/
Expand Down

0 comments on commit c07b4ba

Please sign in to comment.