Skip to content
This repository has been archived by the owner on Jan 26, 2022. It is now read-only.
/ node-gitio Public archive

A nodejs module for accessing the git.io URL shortner

Notifications You must be signed in to change notification settings

tanepiper/node-gitio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gitio

Deprecation

This module is now deprecated as the service no longer accepts requests, the code is only here for archive purposes

A Node.js module to call GitHub's git.io url shortener service.

Library Usage

const gitio = require('gitio');

// Pass a direct URL and get back a random URL
gitio('https://github.com/tanepiper/node-gitio').then(result => {
  console.log(result);
});

// Pass an optional key to get the URL of your request
gitio('https://github.com/joyent/node', 'nodejs').then(result => {
  console.log(result);
});

API

gitio(url, [code])

url

Type: string

The github.com URL to shorten.

code

Type: string

The shortened URL path.

Command line usage

Install and use from the command line. Takes a required github.com url, and an optional code as a second parameter.

> npm install -g gitio
> gitio https://github.com/tanepiper [tanepiper]

About

A nodejs module for accessing the git.io URL shortner

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •