search

socketstream / ss-generator

The app generator for SocketStream
MIT License
2 stars 0 forks source link

readme

ss-generator

The app generator for SocketStream

Build Status Coverage Status Code Climate Codacy Badge

Summary

ss-generator is the CLI component of the SocketStream web framework. It has been extracted out of the framework so that it can be used in a Yeoman generator, as well as to help SocketStream's codebase become more modular.

Installation

It is primarily for use in the SocketSteam module, but you can install it with npm:

npm install ss-generator

Usage

If you then wish to use it programmatically, run the following code:

    var ssGenerator = require('ss-generator');
    ssGenerator.process({args: ['new ', 'my_ss_app']}, function () {
        console.log('app created');
    });

Test

npm test

License

MIT Licence. See License For more details.