Skip to content

Commit 617b237

Browse files
committed
Meta tweaks
1 parent 4c60b6a commit 617b237

File tree

4 files changed

+6
-10
lines changed

4 files changed

+6
-10
lines changed

index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ declare namespace ora {
9494

9595
/**
9696
Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on `Enter` key presses, and prevents buffering of input while the spinner is running.
97-
97+
9898
This has no effect on Windows as there's no good way to implement discarding stdin properly there.
9999
100100
@default true

license

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
3+
Copyright (c) Sindre Sorhus <[email protected]> (https://sindresorhus.com)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
"description": "Elegant terminal spinner",
55
"license": "MIT",
66
"repository": "sindresorhus/ora",
7+
"funding": "https://github.com/sponsors/sindresorhus",
78
"author": {
89
"name": "Sindre Sorhus",
910
"email": "[email protected]",
10-
"url": "sindresorhus.com"
11+
"url": "https://sindresorhus.com"
1112
},
1213
"engines": {
1314
"node": ">=8"

readme.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ora [![Build Status](https://travis-ci.org/sindresorhus/ora.svg?branch=master)](https://travis-ci.org/sindresorhus/ora)
1+
# ora [![Build Status](https://travis-ci.com/sindresorhus/ora.svg?branch=master)](https://travis-ci.com/sindresorhus/ora)
22

33
> Elegant terminal spinner
44
@@ -8,14 +8,12 @@
88
<br>
99
</p>
1010

11-
1211
## Install
1312

1413
```
1514
$ npm install ora
1615
```
1716

18-
1917
## Usage
2018

2119
```js
@@ -29,7 +27,6 @@ setTimeout(() => {
2927
}, 1000);
3028
```
3129

32-
3330
## API
3431

3532
### ora(text)
@@ -73,7 +70,7 @@ Or an object like:
7370

7471
Type: `string`\
7572
Default: `'cyan'`\
76-
Values: `'black'` `'red'` `'green'` `'yellow'` `'blue'` `'magenta'` `'cyan'` `'white'` `'gray'`
73+
Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'`
7774

7875
Color of the spinner.
7976

@@ -228,7 +225,6 @@ Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the
228225

229226
Type: `Promise`
230227

231-
232228
## FAQ
233229

234230
### How do I change the color of the text?
@@ -246,7 +242,6 @@ const spinner = ora(`Loading ${chalk.red('unicorns')}`).start();
246242

247243
JavaScript is single-threaded, so synchronous operations blocks the thread, including the spinner animation. Prefer asynchronous operations whenever possible.
248244

249-
250245
## Related
251246

252247
- [cli-spinners](https://github.com/sindresorhus/cli-spinners) - Spinners for use in the terminal

0 commit comments

Comments
 (0)