Natural Pacifist Manatees
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    titlepublic

    title

    This package correctly capitalizes your titles as per The Chicago Manual of Style. Furthermore, all of ZEIT's product names are capitalized properly as well.

    Usage

    Firstly, install the package:

    yarn add title

    Then load it and convert any input:

    const title = require('title')
     
    title('noW deSktop and now cLI are prODUCts of zeIt')
     
    // Will result in:
    // "Now Desktop and Now CLI Are Products of ZEIT"

    You can even pass words that should be capitalized as specified:

    title('FaCEbook is great', {
      special: [ 'facebook' ]
    })
     
    // Will result in:
    // "facebook is great"

    That's it!

    Command Line

    You can also convert titles in the command line, if you want. Install the package globally:

    yarn global add title

    Next, run it:

    title "noW deSktop and now cLI are prODUCts of zeIt"
     
    # Will result in: 
    # "Now Desktop and Now CLI Are Products of ZEIT" 

    To see all available options, run:

    title -h

    Contributing

    1. Fork this repository to your own GitHub account and then clone it to your local device
    2. Uninstall title if it's already installed: yarn global remove title
    3. Link it to the global module directory: yarn link

    After that, you can use the title command everywhere.

    Author

    install

    npm i title

    Downloadsweekly downloads

    230

    version

    3.3.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar