taigrr/shorturl
1
0
Fork 0
mirror of https://github.com/taigrr/shorturl synced 2025-01-18 04:03:16 -08:00
Code Issues Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
James Mills 2017-07-09 13:11:24 -07:00
parent 74c02644c5
commit 16ab8c178b
No known key found for this signature in database
GPG Key ID: AC4C014F1440EBD6
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -5,7 +5,8 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/prologic/shorturl)](https://goreportcard.com/report/github.com/prologic/shorturl) [![Go Report Card](https://goreportcard.com/badge/github.com/prologic/shorturl)](https://goreportcard.com/report/github.com/prologic/shorturl)
[![Coverage](https://coveralls.io/repos/prologic/shorturl/badge.svg)](https://coveralls.io/r/prologic/shorturl) [![Coverage](https://coveralls.io/repos/prologic/shorturl/badge.svg)](https://coveralls.io/r/prologic/shorturl)
shorturl is a web app that allows you to create smart bookmarks, commands and aliases by pointing your web browser's default search engine at a running instance. Similar to bunny1 or yubnub. shorturl is a web app that allows you to create short urls of much longer more
complex urls for easier sharing or embedding.
## Installation ## Installation
@ -17,6 +18,8 @@ $ go install github.com/prologic/shorturl/...
### OS X Homebrew ### OS X Homebrew
**Coming soon**
There is a formula provided that you can tap and install from There is a formula provided that you can tap and install from
[prologic/homebrew-shorturl](https://github.com/prologic/homebrew-shorturl): [prologic/homebrew-shorturl](https://github.com/prologic/homebrew-shorturl):
@ -37,12 +40,19 @@ much appreciated and highly welcome!
Run shorturl: Run shorturl:
```#!bash ```#!bash
$ shorturl -bind 127.0.0.1:8000 $ shorturl
``` ```
Set your browser's default shorturl engine to http://localhost:8000/?q=%s Then visit: http://localhost:8000/
Then type `help` to view the main help page, `g foo bar` to perform a [Google](https://google.com) search for "foo bar" or `list` to list all available commands. ## Configuration
By default shorturl stores urls in `urls.db` in the local directory. This can
be configured with the `-dbpath /path/to/urls.db` option.
shorturl also displays an absolute url after creating and uses the value of
`-baseurl` (*default: `""`*) for display purposes. This is useful for copying
and pasting the shorturl.
## License ## License