?HAMA

Edit File Size: 1.83 KB

//lib/node_modules/npm/node_modules/qrcode-terminal/README.md

Text Base64

# 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 <gtanner@gmail.com>
    Micheal Brooks <michael@michaelbrooks.ca>

[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

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
bin DIR	-	drwxr-xr-x	2024-03-03 22:36:29	Edit Download recursive recursive
example DIR	-	drwxr-xr-x	2024-03-03 22:36:29	Edit Download recursive recursive
lib DIR	-	drwxr-xr-x	2024-03-03 22:36:29	Edit Download recursive recursive
vendor DIR	-	drwxr-xr-x	2024-03-03 22:36:29	Edit Download recursive recursive
.travis.yml	38 B	lrw-r--r--	2021-03-10 14:36:36	Edit Download recursive recursive
LICENSE	11.68 KB	lrw-r--r--	2021-03-10 14:36:36	Edit Download recursive recursive
package.json	1.86 KB	lrw-r--r--	2021-03-10 14:36:36	Edit Download recursive recursive
README.md	1.83 KB	lrw-r--r--	2021-03-10 14:36:36	Edit Download recursive recursive

Directory Contents