Skip to content

frekyll/star-names

Repository files navigation

✨ star-names Build Status

Get names of the brightest stars in the sky

Photo by Jeremy Bishop on Unsplash

Install

$ npm install @frekyll/star-names

Usage

var starNames = require('@frekyll/star-names')

starNames.random()
//=> 'Mizar'

API

.all

Type: array

50 brightest star names in alphabetical order

.random()

Type: function

Random star name

CLI

$ npm install --global @frekyll/star-names
$ star-names --help

  Examples
    $ star-names
    Mizar
    $ star-names --all
    Achernar
    Acrux
    …
  Options
    --all  Get all names instead of a random name

Related

License

MIT © Frekyll