readmetrunk

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f6b612c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# later
+
+a command for doing things later
+
+## usage
+
+With a `LATERFILE` defined (TBD this may/should also take in a file with `-f`):
+
+`me@computer:~$ later -- command to run later`
+
+Running (TBD):
+
+`me@computer:~$ later --now`
+
+Note: `later` will keep track of the working directory it was in when it ran the command (so relative
+paths should still work) as well as the `PATH` at the time it was run (so e.g. Python `venv`s should
+still work).
+
+## why?
+
+I don't always have network connectivity, or don't want to run something that's going to eat up my battery
+while I'm working, but it's something that I still want to run at some indeterminate point in the future. 
+This allows me to keep track of those things, and hook into them at specific times (i.e. as part of my
+"connect to the internet" script, I can run the laterfile to push any code changes to the remote).
+
+## isn't this problem solved by `<tool>`?
+
+Probably, but I didn't have network connectivity so I couldn't look it up and built something instead.