Skip to content

Commit 06199bd

Browse files
committed
some README fixes
1 parent e927562 commit 06199bd

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

README.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Easy to use Progress-Bar for Command-Line/Terminal Applications
77
Features
88
--------
99

10-
* Simple, Robust and easily to use
11-
* Full customizable output format (various placeholders are available=
10+
* **Simple**, **Robust** and **Easy** to use
11+
* Full customizable output format (various placeholders are available)
1212
* Custom Bar Characters
1313
* FPS limiter
1414
* ETA calculation based on elapsed time
@@ -20,7 +20,7 @@ Features
2020
Installation
2121
------------
2222

23-
You can install cli-progress with [NPM](http://npmjs.com)
23+
You can install cli-progress with [NPM](http://www.npmjs.com/package/cli-progress)
2424

2525
```bash
2626
$ npm install cli-progress
@@ -35,6 +35,10 @@ $ wget https://github.com/AndiDittrich/Node.CLI-Progress/archive/v1.0.0.tar.gz
3535
Progress-Bar
3636
------------
3737

38+
### Getting Started ###
39+
40+
You can find some basic examples in [example.js](https://github.com/AndiDittrich/Node.CLI-Progress/blob/master/example.js) - just run the file with `$ node example.js`
41+
3842
### Usage ###
3943

4044
```js
@@ -92,12 +96,12 @@ Stops the progress bar and go to next line
9296

9397
The progressbar can be customized by using the following build-in placeholders. They can be combined in any order.
9498

95-
- **{bar}** - the progress bar, customizable by the options **barsize**, **barCompleteString** and **barIncompleteString**
96-
- **{percentage}** - the current progress in percent (0-100)
97-
- **{total}** - the end value
98-
- **{value}** - the current value set by last `update()` call
99-
- **{eta}** - expected time of accomplishment in seconds
100-
- **{duration}** - elapsed time in seconds
99+
- `{bar}` - the progress bar, customizable by the options **barsize**, **barCompleteString** and **barIncompleteString**
100+
- `{percentage}` - the current progress in percent (0-100)
101+
- `{total}` - the end value
102+
- `{value}` - the current value set by last `update()` call
103+
- `{eta}` - expected time of accomplishment in seconds
104+
- `{duration}` - elapsed time in seconds
101105

102106
#### Example ####
103107

@@ -113,13 +117,13 @@ progess [========================================] 100% | ETA: 0s | 200/200
113117

114118
### Options ###
115119

116-
- **format** (type:string) - progress bar output format @see format section
117-
- **fps** (type:int) - the maximum update rate
118-
- **stream** (type:stream) - output stream to use (default: `process.stderr`)
119-
- **clearOnComplete** (type:boolean) - clear the progress bar on complete - `stop()` called (default: false)
120-
- **barsize** (type:int) - the length of the progress bar in chars (default: 40)
121-
- **barCompleteString** (type:char) - character to use as "complete" indicator in the bar (default: "=")
122-
- **barIncompleteString** (type:char) - character to use as "incomplete" indicator in the bar (default: "-")
120+
- `format` (type:string) - progress bar output format @see format section
121+
- `fps` (type:int) - the maximum update rate
122+
- `stream` (type:stream) - output stream to use (default: `process.stderr`)
123+
- `clearOnComplete` (type:boolean) - clear the progress bar on complete / `stop()` call (default: false)
124+
- `barsize` (type:int) - the length of the progress bar in chars (default: 40)
125+
- `barCompleteString` (type:char) - character to use as "complete" indicator in the bar (default: "=")
126+
- `barIncompleteString` (type:char) - character to use as "incomplete" indicator in the bar (default: "-")
123127

124128
#### Example ####
125129

example.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ function Example2(onComplete){
6363
value++;
6464

6565
// update the bar value
66-
b2.update(value)
66+
b2.update(value);
6767

6868
// set limit
6969
if (value >= b2.getTotal()){

lib/Gear.js

-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +0,0 @@
1-
/**
2-
* Created by Andi on 10.12.2015.
3-
*/

0 commit comments

Comments
 (0)