Commit 33f2120b authored by Sam Pablo Kuper's avatar Sam Pablo Kuper Committed by Sam Pablo Kuper
Browse files

Update readme

parent e72f99e5
Command-line tool to shorten URLs using [v.gd](https://v.gd).
Command-line tool to shorten URLs using the excellent [v.gd](https://v.gd) url-shortener.
Assuming GNU/Linux with the `apt-get` command installed and working, GNU Bash as your shell, and installation rights available using `sudo`, you install `vgd` as follows:
sudo apt-get install curl gridsite-clients
mkdir -p ~/bin
curl -w "\n" XXXXXX > ~/bin/vgd
chmod ~/bin/vgd
echo -e '\n# Add ~/bin to PATH\nexport PATH="$HOME/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
sudo apt-get install curl gridsite-clients
mkdir -p ~/bin
curl 'https://gitlab.com/sampablokuper/vgd/raw/master/vgd' > ~/bin/vgd
chmod +x ~/bin/vgd
echo -e '\n# Add ~/bin to PATH\nexport PATH="$HOME/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
You can now run vgd by entering `vgd` followed by the URL you want to shorten. Put the URL in single quotes. For example:
......@@ -18,3 +18,5 @@ An example using a longer URL:
$ vgd 'https://en.wikipedia.org/w/index.php?title=CURL&action=history'
https://v.gd/35qysF
N.B. This tool uses the v.gd API, and is therefore subject to that API's [restrictions/limitations](https://v.gd/apishorteningreference.php#restrict).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment