Update broken example in README
diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ae5003..9e7c437 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md
@@ -1,5 +1,10 @@ # Change Log for `process_runner` +## 2.0.3 + +* Updated [README.md](README.md) to fix a broken example. Bumping version to get + updated docs on [pub.dev](https://pub.dev). + ## 2.0.2 * Updated docs and [README.md](README.md). Bumping version to get updated docs
diff --git a/README.md b/README.md index 6b50576..4b67534 100644 --- a/README.md +++ b/README.md
@@ -23,14 +23,15 @@ ```dart import 'package:process_runner/process_runner.dart'; -void main() { - ProcessRunnerResult result = await processRunner.runProcess(['command', 'arg1', 'arg2']); - // Print stdout: - print(result.stdout); - // Print stderr: - print(result.stderr); +Future<void> main() async { + ProcessRunner processRunner = ProcessRunner(); + ProcessRunnerResult result = await processRunner.runProcess(['ls']); + + print('stdout: ${result.stdout}'); + print('stderr: ${result.stderr}'); + // Print interleaved stdout/stderr: - print(result.output); + print('combined: ${result.output}'); } ``` @@ -38,25 +39,36 @@ but it basically looks like this: ```dart +import 'package:process_runner/process_runner.dart'; + +Future<void> main() async { ProcessPool pool = ProcessPool(numWorkers: 2); final List<WorkerJob> jobs = <WorkerJob>[ - WorkerJob('Job 1', ['command1', 'arg1', 'arg2']), - WorkerJob('Job 2', ['command2', 'arg1']), + WorkerJob(['ls'], name: 'Job 1'), + WorkerJob(['df'], name: 'Job 2'), ]; await for (final WorkerJob job in pool.startWorkers(jobs)) { print('\nFinished job ${job.name}'); } +} ``` Or, if you just want the answer when it's done: ```dart +import 'package:process_runner/process_runner.dart'; + +Future<void> main() async { ProcessPool pool = ProcessPool(numWorkers: 2); final List<WorkerJob> jobs = <WorkerJob>[ - WorkerJob('Job 1', ['command1', 'arg1', 'arg2']), - WorkerJob('Job 2', ['command2', 'arg1']), + WorkerJob(['ls'], name: 'Job 1'), + WorkerJob(['df'], name: 'Job 2'), ]; - List<WorkerJob> finishedJobs = pool.runToCompletion(jobs); + List<WorkerJob> finishedJobs = await pool.runToCompletion(jobs); + for (final WorkerJob job in finishedJobs) { + print("${job.name}: ${job.result.stdout}"); + } +} ```
diff --git a/pubspec.yaml b/pubspec.yaml index ccbd1af..6556155 100644 --- a/pubspec.yaml +++ b/pubspec.yaml
@@ -3,7 +3,7 @@ # found in the LICENSE file. name: process_runner -version: 2.0.2 +version: 2.0.3 description: A process invocation astraction for Dart that manages a multiprocess queue. homepage: https://github.com/google/process_runner