Update version number and update documentation

* Use `git clone` directly during clone (yadm-dev#289, yadm-dev#323)
* Fix compatibility bug with Git completions (yadm-dev#318, yadm-dev#321)
* Support relative paths for --yadm-* and -w (yadm-dev#301)
* Improve parsing of if-statement in default template (yadm-dev#303)
* Read files without running cat in subshells (yadm-dev#317)
* Improve portability of updating read-only files (yadm-dev#320)
* Various code improvements (yadm-dev#306, yadm-dev#307, yadm-dev#311)

CHANGES

@@ -1,3 +1,12 @@
+3.1.0
+  * Use `git clone` directly during clone (#289, #323)
+  * Fix compatibility bug with Git completions (#318, #321)
+  * Support relative paths for --yadm-* and -w (#301)
+  * Improve parsing of if-statement in default template (#303)
+  * Read files without running cat in subshells (#317)
+  * Improve portability of updating read-only files (#320)
+  * Various code improvements (#306, #307, #311)
+
 3.0.2
   * Fix parsing by sh (#299)
 

CONTRIBUTORS

@@ -4,13 +4,13 @@ Tim Byrne
 Erik Flodin
 Martin Zuther
 Jan Schulz
+Ross Smith II
 Jonathan Daigle
 Luis López
 Tin Lai
 Espen Henriksen
 Cameron Eagans
 Klas Mellbourn
-Ross Smith II
 Tomas Cernaj
 jonasc
 Chad Wade Day, Jr
@@ -28,8 +28,10 @@ Daniel Wagenknecht
 Stig Palmquist
 Patrick Hof
 con-f-use
+Bram Ceulemans
 Travis A. Everett
 Sheng Yang
+Jared Smartt
 Adam Jimerson
 addshore
 Tim Condit

README.md

@@ -72,7 +72,7 @@ The star count helps others discover yadm.
 [master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master
 [master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
 [master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
-[obs-badge]: https://img.shields.io/badge/OBS-v3.0.2-blue
+[obs-badge]: https://img.shields.io/badge/OBS-v3.1.0-blue
 [obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
 [releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
 [releases-link]: https://github.com/TheLocehiliosan/yadm/releases

yadm

@@ -21,7 +21,7 @@ if [ -z "$BASH_VERSION" ]; then
   [ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
 fi
 
-VERSION=3.0.2
+VERSION=3.1.0
 
 YADM_WORK="$HOME"
 YADM_DIR=

yadm.1

@@ -1,5 +1,5 @@
 .\" vim: set spell so=8:
-.TH yadm 1 "7 January 2021" "3.0.2"
+.TH yadm 1 "3 April 2021" "3.1.0"
 
 .SH NAME
 

yadm.md

@@ -74,23 +74,11 @@
 
        clone url
               Clone a remote repository for tracking dotfiles.  After the con-
-              tents  of  the remote repository have been fetched, a "merge" of
-              the remote HEAD branch is attempted.  If there  are  conflicting
-              files already present in the work-tree, this merge will fail and
-              instead a "reset" of the remote HEAD branch will be  done,  fol-
-              lowed  by  a  "stash".  This "stash" operation will preserve the
-              original data.
-
-              You can review the stashed conflicts by running the command
-
-                     yadm stash show -p
-
-              from within your $HOME directory. If you  want  to  restore  the
-              stashed data, you can run
-
-                     yadm stash apply
-              or
-                     yadm stash pop
+              tents  of the remote repository have been fetched, a "check out"
+              of the remote HEAD branch is attempted.  If there are  conflict-
+              ing  files  already  present in the work-tree, the local version
+              will be left unmodified and you'll have to  review  and  resolve
+              the difference.
 
               The  repository  is  stored in $HOME/.local/share/yadm/repo.git.
               By default, $HOME will be used as the work-tree, but this can be
@@ -235,7 +223,7 @@
               alias yadm='yadm --yadm-repo /alternate/path/to/repo'
 
        The following is the full  list  of  universal  options.   Each  option
-       should be followed by a fully qualified path.
+       should be followed by a path.
 
        -Y,--yadm-dir
               Override  the  yadm  directory.   yadm stores its configurations

yadm.spec

@@ -1,7 +1,7 @@
 %{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
 Name: yadm
 Summary: Yet Another Dotfiles Manager
-Version: 3.0.2
+Version: 3.1.0
 Group: Development/Tools
 Release: 1%{?dist}
 URL: https://yadm.io