https://github.com/gtanner/qrcode-terminal

QRCodes in your terminal, cause thats hot.
https://github.com/gtanner/qrcode-terminal

Last synced: 6 days ago
JSON representation

QRCodes in your terminal, cause thats hot.

• Host: GitHub
• URL: https://github.com/gtanner/qrcode-terminal
• Owner: gtanner
• License: apache-2.0
• Created: 2013-02-28T01:28:19.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2022-01-28T07:52:41.000Z (about 3 years ago)
• Last Synced: 2024-10-29T14:57:07.174Z (3 months ago)
• Language: JavaScript
• Size: 88.9 KB
• Stars: 1,279
• Watchers: 18
• Forks: 100
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - qrcode-terminal - QRCodes in your terminal.  (Repository / Command-line Utilities)
• awesome-npm - qrcode-terminal - 终端输出二维码 (3. 命令行程序 / 3.1 开发库)
• awesome-ascii - qrcode-terminal

README

        
# QRCode Terminal Edition [![Build Status][travis-ci-img]][travis-ci-url]

> Going where no QRCode has gone before.

![Basic Example][basic-example-img]

# Node Library

## Install

Can be installed with:

    $ npm install qrcode-terminal

and used:

    var qrcode = require('qrcode-terminal');

## Usage

To display some data to the terminal just call:

    qrcode.generate('This will be a QRCode, eh!');

You can even specify the error level (default is 'L'):

    

    qrcode.setErrorLevel('Q');

    qrcode.generate('This will be a QRCode with error level Q!');

If you don't want to display to the terminal but just want to string you can provide a callback:

    qrcode.generate('http://github.com', function (qrcode) {

        console.log(qrcode);

    });

If you want to display small output, provide `opts` with `small`:

    qrcode.generate('This will be a small QRCode, eh!', {small: true});

    qrcode.generate('This will be a small QRCode, eh!', {small: true}, function (qrcode) {

        console.log(qrcode)

    });

# Command-Line

## Install

    $ npm install -g qrcode-terminal

## Usage

    $ qrcode-terminal --help

    $ qrcode-terminal 'http://github.com'

    $ echo 'http://github.com' | qrcode-terminal

# Support

- OS X

- Linux

- Windows

# Server-side

[node-qrcode][node-qrcode-url] is a popular server-side QRCode generator that

renders to a `canvas` object.

# Developing

To setup the development envrionment run `npm install`

To run tests run `npm test`

# Contributers

    Gord Tanner 

    Micheal Brooks 

[travis-ci-img]: https://travis-ci.org/gtanner/qrcode-terminal.png

[travis-ci-url]: https://travis-ci.org/gtanner/qrcode-terminal

[basic-example-img]: https://raw.github.com/gtanner/qrcode-terminal/master/example/basic.png

[node-qrcode-url]: https://github.com/soldair/node-qrcode