diff
/
CheckIn
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Include an example in README.md

main
diff 2023-12-12 17:37:27 +00:00
parent 7cf1c75fb8
commit 795a5b97bc
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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.
```