https://github.com/cjpatoilo/cname

Create a CNAME file from package data.
https://github.com/cjpatoilo/cname

automation cli cname npm tooling tools

Last synced: 4 months ago
JSON representation

Create a CNAME file from package data.

• Host: GitHub
• URL: https://github.com/cjpatoilo/cname
• Owner: cjpatoilo
• License: mit
• Created: 2016-12-07T16:31:51.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T01:20:40.000Z (almost 2 years ago)
• Last Synced: 2024-10-16T07:23:28.930Z (4 months ago)
• Topics: automation, cli, cname, npm, tooling, tools
• Language: JavaScript
• Homepage: https://cjpatoilo.com/cname
• Size: 162 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • Funding: .github/funding.yml
  • License: license

Awesome Lists containing this project

README

        


> Create a CNAME file from package data.

[![Travis Status](https://travis-ci.org/cjpatoilo/cname.svg?branch=master)](https://travis-ci.org/cjpatoilo/cname?branch=master)

[![AppVeyor Status](https://ci.appveyor.com/api/projects/status/bl59wj551tbofupk?svg=true)](https://ci.appveyor.com/project/cjpatoilo/cname)

[![Codacy Status](https://img.shields.io/codacy/grade/04510cf9543142e2bcf340fa84e33371/master.svg)](https://www.codacy.com/app/cjpatoilo/cname/dashboard)

[![Coverage Status](https://coveralls.io/repos/github/cjpatoilo/cname/badge.svg?branch=master)](https://coveralls.io/github/cjpatoilo/cname?branch=master)

[![devDependencies Status](https://david-dm.org/cjpatoilo/cname/dev-status.svg)](https://david-dm.org/cjpatoilo/cname?type=dev)

[![Version Status](https://badge.fury.io/js/cname.svg)](https://www.npmjs.com/package/cname)

[![Download Status](https://img.shields.io/npm/dt/cname.svg)](https://www.npmjs.com/package/cname)

[![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/cname)

## Why it's awesome

Install this package npm with `-g` to global use or with `-D` to add the package as a devDependency in the `package.json` file of your project. This lib reads the `package.json` files to get the homepage value, then creates the `CNAME` file with that value.

## Install

**Install with npm**

```sh

$ npm install cname --global

```

**Install with Yarn**

```sh

$ yarn install cname --global

```

## Usage

```

$ cname --help

  Usage:

    $ cname  []

  Options:

    -h, --help              Display help information

    -v, --version           Output version

  Examples:

    $ cname dist

```

## Example

From package data..

```json

// package.json

{

  "name": "milligram",

  "version": "1.5.0",

  "description": "A minimalist CSS framework.",

  "homepage": "https://milligram.io",

  "repository": "milligram/milligram",

  "license": "MIT",

  "author": "CJ Patoilo ",

  "main": "dist/milligram.css"

}

```

..to create CNAME file.

```md

// CNAME

milligram.io

```

## Contributing

Want to contribute? Follow these [recommendations](https://github.com/cjpatoilo/cname/contribute).

## License

Designed with ♥ by [CJ Patoilo](https://twitter.com/cjpatoilo). Licensed under the [MIT License](https://cjpatoilo.com/license).