diff --git a/CHANGELOG.md b/CHANGELOG.md index b8a1fa0..a02758c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,13 +5,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## Unreleased +## [v0.1.1] - 2018-09-15 ### Changed - Replace Makefile with [magefile](https://github.com/magefile/mage) - Switch from dep to go module +### Fixed + +- Correctly build distribution executables + ## v0.1.0 - 2018-06-11 ### Added @@ -25,3 +29,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Options to set minimum and maximum word length. - Control the character used to separate words in the passphrase. - Support config files for changing defaults for all command-line options. + +[v0.1.1]: https://github.com/wfscheper/xkcdpwd/compare/v0.1.0...master diff --git a/README.md b/README.md index e5b2246..1be400b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A passphrase generator in the style of XKCD comic **[Password Strength]**. ## Getting started -This project requires Go to be installed. +This project requires Go 1.11 to be installed, as it uses the new go module system for dependency management. On OS X with Homebrew you can just run `brew install go`. On Linux check with your distro's package manager. Alternatively, or on Windows, download the Go source or binary from [golang.org](https://golang.org/dl/). @@ -12,19 +12,20 @@ Alternatively, or on Windows, download the Go source or binary from [golang.org] Running it then should be as simple as: ```console -$ make -... -▶ building executable… +$ git clone https://gitub.com/wfscheper/xkcdpwd.git +$ cd xkcdpwd +$ go get github.com/magefile/mage +$ mage $ bin/xkcdpwd ``` ## Testing -``make test`` +``mage test`` To generate coverage data: -``make test-coverage`` +``mage coverage`` ## Similar projects diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 6908330..0000000 --- a/TODO.md +++ /dev/null @@ -1,9 +0,0 @@ -# Features to implement - -- number of words in passphrase -- word separator -- case of output - - all caps - - randomly uppper case letters - - capitalize X words -- minimum and maximum length of words