commit 4cbeda3469e47dd4b29979edd6e23a7cf297bd31
parent 787355e2982077088bb70f6e0e506aafe03365cb
Author: Oscar Benedito <oscar@oscarbenedito.com>
Date:   Tue, 23 Jun 2020 14:21:25 +0200

Reformat Markdown files

Diffstat:

MREADME.md | 34+++++++++++++++++++++++++---------


1 file changed, 25 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
@@ -1,16 +1,21 @@
 # Git Backup
 
-Very simple script to back up all the repositories the user is member of on GitLab and GitHub.
+Very simple script to back up all the repositories the user is member of on
+GitLab and GitHub.
 
 ## Prerequisites
 
-In order to run the program, you will need `python3` and the python libraries specified in the `requirements.txt` file. If you have `pip3` installed, you can install the libraries with the command:
+In order to run the program, you will need `python3` and the python libraries
+specified in the `requirements.txt` file. If you have `pip3` installed, you can
+install the libraries with the command:
 
 ```
 pip3 install -r requirements.txt
 ```
 
-You will also need a GitLab and a GitHub access token and crete a file named `tokens.json` with the following content:
+You will also need a GitLab and a GitHub access token and crete a file named
+`tokens.json` with the following content:
+
 ```json
 {
   "gitlab.com":"<GitLab token>",
@@ -18,7 +23,8 @@ You will also need a GitLab and a GitHub access token and crete a file named `to
 }
 ```
 
-Finally, you must upload your ssh key to GitLab or GitHub if you have any private or internal repositories.
+Finally, you must upload your ssh key to GitLab or GitHub if you have any
+private or internal repositories.
 
 ## Running the program
 
@@ -30,7 +36,10 @@ python3 git-backup.py
 
 ### Adding custom repositories
 
-If you want to backup repositories from which you are not a member on the currently supported hosts, or if you want to add repositories from other hosts, you can do so creating a file named `custom_directories.json` with the following structure:
+If you want to backup repositories from which you are not a member on the
+currently supported hosts, or if you want to add repositories from other hosts,
+you can do so creating a file named `custom_directories.json` with the following
+structure:
 
 ```json
 [
@@ -44,17 +53,24 @@ If you want to backup repositories from which you are not a member on the curren
 ]
 ```
 
-You can add more than one object to the array and it will backup all of the repositories. Make sure that you upload your ssh key to the hosts in case it is needed for authentification.
+You can add more than one object to the array and it will backup all of the
+repositories. Make sure that you upload your ssh key to the hosts in case it is
+needed for authentification.
 
 ## Future updates
 
- - [ ] More information on the output file or the terminal: how many new repositories were added, how many have been deleted on the hosting services.
- - [ ] Manage what happens if history has changed in the hosting service.
+- [ ] More information on the output file or the terminal: how many new
+      repositories were added, how many have been deleted on the hosting
+      services.
+- [ ] Manage what happens if history has changed in the hosting service.
 
 ## License
 
-The program is licensed under the GNU General Public License version 3 (available [here](https://www.gnu.org/licenses/gpl-3.0.html)).
+The program is licensed under the GNU General Public License version 3
+(available [here][gpl]).
 
 ## Author
 
 - **Oscar Benedito** - oscar@oscarbenedito.com
+
+[gpl]: <https://www.gnu.org/licenses/gpl-3.0.html> "The GNU General Public License v3.0"