generate-cname

    1.0.0 • Public • Published

    generate-cname NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Generate the CNAME file for a web project. Is this necessary? No, not at all. A CNAME file is one line and takes a couple seconds to create. The point of this generator is to automate the creation of the CNAME file based on configuration settings, as a small part of a larger build.

    Install

    Install with npm:

    $ npm install --save generate-cname

    Usage

    CLI

    Install

    First install generate and this module either globally or locally:

    $ npm install --global generate generate-cname

    Generate a CNAME file on demand

    The following command will prompt you for the URL to use, then will write a CNAME file to the cwd or specified --dest:

    $ gen cname 
    $ gen cname --dest ./foo

    Use as a plugin

    You can add a cname task to your generate generator by adding the following line in generator.js:

    app.use(require('generate-cname'));

    Example

    Given you have a generator named generate-foo, you would run the following to generate a cname file:

    $ gen foo:cname

    You can also run the cname task from any other task in your generator, so that a cname file is automatically generated along with other files.

    About

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

    Building docs

    (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

    To generate the readme, run the following command:

    $ npm install -g verbose/verb#dev verb-generate-readme && verb

    Running tests

    Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2017, Jon Schlinkert. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.6.0, on July 29, 2017.

    Install

    npm i generate-cname

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert