From 795a5b97bc93d284f026a4bcbb358176d33ffc83 Mon Sep 17 00:00:00 2001 From: diff Date: Tue, 12 Dec 2023 17:37:27 +0000 Subject: [PATCH] Include an example in README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 75f21b6..294d2eb 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ CheckIn is a way to let other people know what the heck you're up to. +It's intended for multi-user systems like tilde.town. + It's essentially a status. But like. For your terminal. Has that been done already? Has to have been, right? @@ -14,3 +16,13 @@ already? Has to have been, right? `checkin get [--freshness=14]` `--freshness` controls how new (in days) messages must be in order to be printed. + +## Example: + + +``` +diff:~/p/Apricitas > checkin set --include-wd "is trying to wrap his lil head around making a raytracer" +diff:~/p/Apricitas > checkin get + ~diff is trying to wrap his lil head around making a raytracer. (~diff/projects/Apricitas) + ~exampleuser is busy setting an example. +``` \ No newline at end of file