Add the docs (#25)

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.6.1] - 2019-09-02
+### Added
+- the documentation section about retaining the build number
+### Fixed
+- function tests failing randomly due to missing `await`
+
 ## [0.6.0] - 2019-09-02
 ### Added
 - the `--retain-build` (`-b`) flag to retain the build number when bumping versions
@@ -45,7 +51,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial version
 
-[Unreleased]: https://github.com/f3ath/pubspec-version/compare/0.6.0...HEAD
+[Unreleased]: https://github.com/f3ath/pubspec-version/compare/0.6.1...HEAD
+[0.6.1]: https://github.com/f3ath/pubspec-version/compare/0.6.0...0.6.1
 [0.6.0]: https://github.com/f3ath/pubspec-version/compare/0.5.0...0.6.0
 [0.5.0]: https://github.com/f3ath/pubspec-version/compare/0.4.0...0.5.0
 [0.4.0]: https://github.com/f3ath/pubspec-version/compare/0.3.0...0.4.0

README.md

@@ -33,6 +33,18 @@ Before | Command | After
 The `bump build` command is a bit tricky. It either increments the first numeric part of the build (if there is a 
 numeric part) setting other numeric parts to zeroes, or appends `.1` to the build (otherwise).
 
+### Retaining the build number
+When bumping either **major**, **minor**, or **patch** versions, it is possible to retain the existing build number (if any).
+To do so, pass `--retain-build` (`-b`) flag.
+
+Before | Command | After
+--- | --- | ---
+1.2.3+42 | `pubver bump breaking`       | 2.0.0
+0.2.1+42 | `pubver bump breaking -b`    | 0.3.0+42
+0.2.1+42 | `pubver bump patch`          | 0.2.2
+0.2.1+42 | `pubver bump patch -b`       | 0.2.2+42
+
+
 ### Setting the version
 ```
 pubver set <version>

pubspec.yaml

@@ -2,7 +2,7 @@ author: "Alexey Karapetov <karapetov@gmail.com>"
 description: "A CLI tool to set/bump the package version in pubspec.yaml. The \"npm version\" for Dart."
 homepage: "https://github.com/f3ath/pubspec-version"
 name: "pubspec_version"
-version: "0.6.0"
+version: "0.6.1"
 dependencies: 
   args: "^1.5.0"
   pub_semver: "^1.4.2"

test/functional_test.dart

@@ -22,7 +22,7 @@ void main() {
 
   setUp(() async {
     temp = await Directory.systemTemp.createTemp();
-    File('test/pubspec_sample.yaml').copy('${temp.path}/pubspec.yaml');
+    await File('test/pubspec_sample.yaml').copy('${temp.path}/pubspec.yaml');
     mockConsole = MockConsole();
     app = buildApp(mockConsole);
   });