blob: 42c10a5528e9ab6480c89046c5f7a747e2805329 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
# title
This package correctly capitalizes your titles as per [The Chicago Manual of Style](http://www.chicagomanualofstyle.org/home.html). Furthermore, all of
ZEIT's product names are capitalized properly as well.
## Usage
Firstly, install the package:
```bash
yarn add title
```
Then load it and convert any input:
```js
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:
```js
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:
```bash
yarn global add title
```
Next, run it:
```bash
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:
```bash
title -h
```
## Contributing
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) 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
- Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [ZEIT](https://zeit.co)
- Josh Junon ([@Qix-](https://github.com/Qix-)) - [ZEIT](https://zeit.co)
|
