fixed docs: preset argument is of type object not string

npkgz · Apr 26, 2017 · ccce482 · ccce482
1 parent bc91be3
commit ccce482
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -55,8 +55,8 @@ You can find some basic examples in [example.js](https://github.com/AndiDittrich
 ```js
 var _progress = require('cli-progress');
 
-// create a new progress bar instance
-var bar1 = new _progress.Bar();
+// create a new progress bar instance and use shades_classic theme
+var bar1 = new _progress.Bar({}, _progress.Presets.shades_classic);
 
 // start the progress bar with a total value of 200 and start value of 0
 bar1.start(200, 0);
@@ -75,7 +75,7 @@ bar1.stop();
 Initialize a new Progress bar. An instance can be used **multiple** times! it's not required to re-create it!
 
 ```js
-var <instance> = new namespace.Bar(options:object, preset:string);
+var <instance> = new namespace.Bar(options:object, preset:object);
 ```
 
 #### start() ####

diff --git a/example-presets.js b/example-presets.js
@@ -6,7 +6,7 @@ function showPreset(name){
     console.log(_colors.magenta('Preset: ' + name));
 
     // create a new progress bar with preset
-    var bar = new _progress.Bar({}, _progress.Presets[name] || 'legacy');
+    var bar = new _progress.Bar({}, _progress.Presets[name] || _progress.Presets.legacy);
     bar.start(200, 0);
 
     // random value 1..200

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cli-progress",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Easy to use Progress-Bar for Command-Line/Terminal Applications",
   "keywords": [
     "cli",