From ae8ea2a219a94823e96d85a1e53b131aaae05a71 Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Tue, 3 Feb 2015 12:00:04 -0800 Subject: [PATCH 1/3] readme tweaks --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e282392..5eb257b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # cli_util -Utilities to help in building Dart command-line apps. +A utility to help in building Dart command-line apps. -In particular, ``cli_util`` provides a simple, standardized way to get the current SDK directory. Useful, especially, when building client applications that interact with the Dart SDK (such as the [analyzer](https://pub.dartlang.org/packages/analyzer)). - -## Install - -```shell -pub global activate cli_util -``` +In particular, ``cli_util`` provides a simple, standardized way to get the +current SDK directory. Useful, especially, when building client applications +that interact with the Dart SDK (such as the [analyzer][analyzer]). ## Usage @@ -19,10 +15,9 @@ import 'package:cli_util/cli_util.dart'; import 'package:path/path.dart' as path; main(args) { - // Get sdk dir from cli_util Directory sdkDir = getSdkDir(args); - + // Do stuff... For example, print version string File versionFile = new File(path.join(sdkDir.path, 'version')); print(versionFile.readAsStringSync()); @@ -33,4 +28,5 @@ main(args) { Please file feature requests and bugs at the [issue tracker][tracker]. +[analyzer]: https://pub.dartlang.org/packages/analyzer [tracker]: https://github.com/dart-lang/cli_util/issues From c96c42ddc0c0b0c671158f82d09e3557a1dd26d8 Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Tue, 3 Feb 2015 12:01:47 -0800 Subject: [PATCH 2/3] ws --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5eb257b..d1549ad 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ import 'package:path/path.dart' as path; main(args) { // Get sdk dir from cli_util Directory sdkDir = getSdkDir(args); - + // Do stuff... For example, print version string File versionFile = new File(path.join(sdkDir.path, 'version')); print(versionFile.readAsStringSync()); From 545fe325baaf12a32711165ff27a80df9a71d391 Mon Sep 17 00:00:00 2001 From: Devon Carew Date: Tue, 3 Feb 2015 12:03:58 -0800 Subject: [PATCH 3/3] de-dup backticks --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d1549ad..06bad90 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ A utility to help in building Dart command-line apps. -In particular, ``cli_util`` provides a simple, standardized way to get the -current SDK directory. Useful, especially, when building client applications -that interact with the Dart SDK (such as the [analyzer][analyzer]). +In particular, `cli_util` provides a simple, standardized way to get the current +SDK directory. Useful, especially, when building client applications that +interact with the Dart SDK (such as the [analyzer][analyzer]). ## Usage