From a4568d42e2b37eaea1c468f5181699549fbc899f Mon Sep 17 00:00:00 2001
From: "flyingscorpio@arch-desktop" <tfranken@protonmail.com>
Date: Fri, 5 Mar 2021 20:18:45 +0100
Subject: [PATCH] Start explaining the yml commands

---
 README.md   | 32 +++++++++++++++++++++++++++++++-
 configs.yml |  2 +-
 install.py  |  2 +-
 3 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index f59b114..2c486cf 100644
--- a/README.md
+++ b/README.md
@@ -53,12 +53,42 @@ Never seems to remain empty...
 
 
 # YML commands
-The yml `configs.yml` file contains instructions as keys, which trigger commands.
+`configs.yml` contains instructions as keys, which trigger commands.
 Here is a brief explanation of the implemented commands:
 
 * `clone`<br>
 Performs a `git clone`.
 
+* `copy`<br>
+Copy a file.
+
+* `download`<br>
+Download a file with a URL.
+
+* `install`<br>
+Use the package manager to install a package.
+
+* `include`<br>
+Include another config file (also yml).
+
+* `run`<br>
+Pass a line of text to a subshell.
+
+* `depend`<br>
+Install another part of the config file before.
+
+* `symlink`<br>
+Make a symlink.
+
+* `symlink_dir`<br>
+Make a symlink to a directory.
+
+* `append`<br>
+Append text to the end of a file.
+
+* `write`<br>
+Write text to a file, overwriting if it exists.
+
 
 # Thanks
 The idea for the architecture was taken from Dimitri Merejkowsky's [GitHub](https://github.com/dmerejkowsky/dotfiles).
diff --git a/configs.yml b/configs.yml
index 866cce6..609664c 100644
--- a/configs.yml
+++ b/configs.yml
@@ -364,7 +364,7 @@ vim:
         condition: update
 
 neovim:
-    - dependency:
+    - depend:
         - vim
     - install:
         - neovim
diff --git a/install.py b/install.py
index 356cae5..e11dfd2 100755
--- a/install.py
+++ b/install.py
@@ -269,7 +269,7 @@ class Installer:
 
         self.base_dir.chdir()
 
-    def do_dependency(self, *programs: str) -> None:
+    def do_depend(self, *programs: str) -> None:
         """Process a program from the config file as a dependency of another program."""
 
         for program in programs: