Update README

diff --git a/README.md b/README.md
index e845eade966440ce05a7e312161bf9f7f007b806..44748d1e7d1f566bcee79c28943fba4263067bce 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,69 @@
-# xdg-ninja
+<div>
+  <h1 align="center">xdg-ninja</h1>
+  <h5 align="center">Because you wouldn't let just anyone into your <i>$HOME</i></h5>
+</div>
+
+A shell script which checks your _$HOME_ for unwanted files and directories.
+
+When it encounters a file it knows about, it will tell you whether it's possible to move this file to an appropriate location, and how to do it.
+
+## Configuration
+
+The configuration is done in the _programs/_ directory.
+
+You define a program, and then a list of files and directories which this program ruthlessly puts into your _$HOME_ directory.
+
+For each file/directory, you specify if it can be (re)moved.
+
+If this is the case, you also specify instructions on how to accomplish this in markdown.
+
+Files in this directory can have any name, but using the name of the program is encouraged.
+
+### Example
+
+We're going to use _git_ as an example.
+
+It puts the file _.gitconfig_ into _$HOME.
+
+Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_.
+
+We can use that last sentence as our instructions. In this case, there are no newlines, so escaping this string for use in json is trivial, however, this is how you should generally approach it:
+```bash
+echo "Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_." | jq -aRs .
+```
+
+Let's see what the output of this command looks like for something a little more sophisticated.
+Here's an example file:
+```bash
+cat example.md
+```
+```
+Currently not fixable.
+
+_(But you can probably just delete the dir)_
+```
+Here's what catting this file to the _jq_ command produces:
+```bash
+cat example.md | jq -aRs .
+```
+```
+"Currently not fixable.\n\n_(But you can probably just delete the dir)_\n"
+```
+
+Now, we can assemble our final json file:
+```json
+{
+    "name": "git",
+    "files": [
+        {
+            "path": "$HOME/.gitconfig",
+            "movable": true,
+            "help": "Luckily, the XDG spec is supported by git, so we can simply move the file to _XDG_CONFIG_HOME/git/config_.\n"
+        }
+    ]
+}
+```
+
+Saving this as _git.json_ in the _programs/_ directory will result in the script picking it up and checking the file.
+
+If you've created a configuration for a file that isn't in the offical repository yet, make sure to create a pull request so that other people can benefit from it as well.

diff --git a/xdg-ninja.sh b/xdg-ninja.sh
index c7633c07ff94da6e236b0e9f979fde93cd2c85f8..8d982693cc1ea81cfb97ece8bdb66dd0e3918c39 100755 (executable)
--- a/xdg-ninja.sh
+++ b/xdg-ninja.sh
@@ -112,7 +112,6 @@ check_program() {
     INPUT=$1
 
     NAME=$(echo "$INPUT" | jq -r .name)
     INPUT=$1
 
     NAME=$(echo "$INPUT" | jq -r .name)

-

     
 
     while IFS= read -r file; do
     
 
     while IFS= read -r file; do


@@ -122,7 +121,7 @@ check_program() {
 
 # Loops over all files in the programs/ directory and calls check_program
 enumerate_programs() {
 
 # Loops over all files in the programs/ directory and calls check_program
 enumerate_programs() {

-    for prog_filename in "./programs/*"; do
+    for prog_filename in ./programs/*; do

         check_program "$(cat $prog_filename)"
     done
 }
         check_program "$(cat $prog_filename)"
     done
 }