From 45752f267213e49609a73349139e393691dbb815 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=ABl=20Stemmer?= Date: Fri, 4 Oct 2019 00:02:18 +0100 Subject: [PATCH] Reorganize README Move the contribution section to the bottom and fix the formatting of the test section. --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4ea2658..3bb1989 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,6 @@ command: go get -u github.com/jstemmer/go-junit-report ``` -## Contribution - -Create an Issue and discuss the fix or feature, then fork the package. -Clone to github.com/jstemmer/go-junit-report. This is necessary because go import uses this path. -Fix or implement feature. Test and then commit change. -Specify #Issue and describe change in the commit message. -Create Pull Request. It can be merged by owner or administrator then. - -## Run Tests -go test - ## Usage go-junit-report reads the `go test` verbose output from standard in and writes @@ -38,7 +27,21 @@ go test -v 2>&1 | go-junit-report > report.xml Note that it also can parse benchmark output with `-bench` flag: ```bash go test -v -bench . -count 5 2>&1 | go-junit-report > report.xml - ``` +``` + +## Contribution + +Create an Issue and discuss the fix or feature, then fork the package. +Clone to github.com/jstemmer/go-junit-report. This is necessary because go import uses this path. +Fix or implement feature. Test and then commit change. +Specify #Issue and describe change in the commit message. +Create Pull Request. It can be merged by owner or administrator then. + +### Run Tests + +```bash +go test +``` [travis-badge]: https://travis-ci.org/jstemmer/go-junit-report.svg [travis-link]: https://travis-ci.org/jstemmer/go-junit-report