From 0030878ad75470d6d7d447a115196ac26c2509c4 Mon Sep 17 00:00:00 2001
From: Casey Rodarmor <casey@rodarmor.com>
Date: Sat, 14 Oct 2017 23:18:46 -0700
Subject: [PATCH] Create a short markdown readme for crates.io

---
 Cargo.lock          |  2 +-
 Cargo.toml          |  4 ++--
 crates-io-readme.md | 22 ++++++++++++++++++++++
 3 files changed, 25 insertions(+), 3 deletions(-)
 create mode 100644 crates-io-readme.md

diff --git a/Cargo.lock b/Cargo.lock
index 770515e..0495733 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1,6 +1,6 @@
 [root]
 name = "just"
-version = "0.3.2"
+version = "0.3.3"
 dependencies = [
  "ansi_term 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "atty 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)",
diff --git a/Cargo.toml b/Cargo.toml
index 1d165bc..340f9f9 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
 name        = "just"
-version     = "0.3.2"
+version     = "0.3.3"
 description = "🤖 Just a command runner"
 authors     = ["Casey Rodarmor <casey@rodarmor.com>"]
 license     = "WTFPL OR MIT OR Apache-2.0"
 homepage    = "https://github.com/casey/just"
-readme      = "README.asc"
+readme      = "crates-io-readme.md"
 
 [dependencies]
 ansi_term     = "^0.9.0"
diff --git a/crates-io-readme.md b/crates-io-readme.md
new file mode 100644
index 0000000..c05ac0a
--- /dev/null
+++ b/crates-io-readme.md
@@ -0,0 +1,22 @@
+`just` is a handy way to save and run project-specific commands.
+
+Commands are stored in a file called `justfile` or `Justfile` with syntax inspired by `make`:
+
+```make
+build:
+    cc *.c -o main
+
+# test everything
+test-all: build
+    ./test --all
+
+# run a specific test
+test TEST: build
+    ./test --test {{TEST}}
+```
+
+`just` produces detailed error messages and avoids `make`'s idiosyncrasies, so debugging a justfile is easier and less surprising than debugging a makefile.
+
+It works on Linux, MacOS, and Windows.
+
+Read more on [GitHub](https://github.com/casey/just).