Rename to pls and add some more docs

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "taskrunner"
+name = "pls"
 version = "0.1.0"
 edition = "2021"
 

README.md

@@ -1,4 +1,6 @@
-# Task Runner
+# `pls` - A Task Runner
+
+`pls` runs tasks; kind of like Make, but more modern.
 
 ## Features
 
@@ -42,6 +44,96 @@
 
 * :fast_forward: Some way to flatten out to run the same commands in CI?
 
+## Usage
+
+Usage is driven by a file called `pls.toml`. Create this at the root of your project
+(next to your `.git` directory), add add it to version control.
+
+### Commands
+
+The file describes a series of commands that you can run, like this:
+
+```toml
+[command.exec.hello]
+command = "echo hello world"
+```
+
+This defines a command called `hello`, so we can run it with:
+
+```console
+$ pls run hello
+[command.exec.hello] Running echo hello world
+hello world
+```
+
+You can define a number of commands that do different things, and with different
+arguments depending on your needs.
+
+```toml
+[command.exec.hello]
+command = "echo hello world"
+
+[command.exec.goodbye]
+command = "echo goodbye"
+```
+
+#### Container commands
+
+You can also specify commands that run inside containers using `podman`.
+
+```toml
+[command.container.hello]
+image = 'docker.io/alpine:latest
+command = echo hello
+```
+
+They can then be run in exactly the same way.
+
+```console
+$ pls run hello
+[command.exec.hello] Running container using docker.io/alpine:latest
+hello
+```
+
+This allows you to rely on specific versions of tools, or other cases
+where using a container is preferable.
+
+#### Arguments
+
+#### Dependencies with `requires`
+
+You can specify that one command needs to run after another by using
+the `requires` configuration option.
+
+```toml
+[command.container.one]
+image = 'docker.io/alpine:latest
+command = echo one
+
+[command.exec.two]
+command = echo two
+```
+
+#### Reuse with `extends`
+
+#### Variables
+
+#### Long-running commands with daemons
+
+#### Outputs
+
+### Artifacts
+
+#### Container Images
+
+#### Timestamp comparisons
+
+#### Last-run comparisons
+
+#### Forcing a rebuild to happen
+
+### Descriptions
+
 ## Detecting changes
 
 When in watch mode you want a set of paths to trigger changes, with some excludes.
@@ -123,8 +215,8 @@ uses = "cargo_with_db"
 args = "run"
 ```
 
-`taskrunner run <COMMAND> [ARGS...]` to run a command or build an artifact
+`pls run <COMMAND> [ARGS...]` to run a command or build an artifact
 (with disambiguation). Provides the way to force a build to happen.
 
-`taskrunner build <ARTIFACT>` to build an artifact, taking in to account
+`pls build <ARTIFACT>` to build an artifact, taking in to account
 whether deps have changed etc.

src/config.rs

@@ -343,7 +343,7 @@ impl ExecArtifact {
     }
 }
 
-pub const CONFIG_FILE_NAME: &str = "taskrunner.toml";
+pub const CONFIG_FILE_NAME: &str = "pls.toml";
 
 pub fn find_config_file() -> Option<std::path::PathBuf> {
     let mut config_dir = std::env::current_dir().unwrap();

src/target.rs

@@ -616,18 +616,18 @@ fn find_required(target: &TargetInfo, context: &Context) -> Result<Vec<Target>>
 }
 
 fn metadata_path(name: &str) -> Result<std::path::PathBuf> {
-    Ok(std::env::current_dir()?.join(".taskrunner").join(name))
+    Ok(std::env::current_dir()?.join(".pls").join(name))
 }
 
 pub fn create_metadata_dir(name: &str) -> Result<std::path::PathBuf> {
-    let taskrunner_dir = metadata_path(name)?;
+    let config_dir = metadata_path(name)?;
     debug!(
         "Creating metadata dir for target <{}> at <{}>",
         name,
-        taskrunner_dir.display()
+        config_dir.display()
     );
-    std::fs::create_dir_all(&taskrunner_dir)?;
-    Ok(taskrunner_dir)
+    std::fs::create_dir_all(&config_dir)?;
+    Ok(config_dir)
 }
 
 fn last_run_path(target: &TargetInfo) -> Result<std::path::PathBuf> {

src/targets/command/container.rs

@@ -141,9 +141,9 @@ impl Startable for ContainerCommand {
             self.target_info.name, self.command
         );
 
-        let taskrunner_dir = create_metadata_dir(self.target_info.name.to_string().as_str())?;
-        let pid_path = taskrunner_dir.join("pid");
-        let log_path = taskrunner_dir.join("log");
+        let config_dir = create_metadata_dir(self.target_info.name.to_string().as_str())?;
+        let pid_path = config_dir.join("pid");
+        let log_path = config_dir.join("log");
         let image_name =
             context.resolve_substitutions(self.image.as_str(), &self.target_info.name, outputs)?;
         let log_start = || {
@@ -170,11 +170,9 @@ impl Startable for ContainerCommand {
         _outputs: &mut OutputsManager,
         _cleanup_manager: Arc<Mutex<CleanupManager>>,
     ) -> Result<()> {
-        let taskrunner_dir = std::env::current_dir()?
-            .join(".taskrunner")
-            .join(self.target_info.name.to_string().as_str());
+        let config_dir = create_metadata_dir(self.target_info.name.to_string().as_str())?;
 
-        let pid_path = taskrunner_dir.join("pid");
+        let pid_path = config_dir.join("pid");
         debug!(
             "Searching for pid file for target <{}> at <{}>",
             self.target_info.name,