md README

This commit is contained in:
StackSmith 2021-11-07 12:58:26 -06:00
parent 4cc0e471e7
commit e0b0876489
1 changed files with 4 additions and 3 deletions

View File

@ -1,4 +1,4 @@
gemlog_index <dir>
# gemlog_index <dir>
gemlog utility generates an index of all gemlog entries in the specified directory. The index is a list of gemtext links.
@ -7,11 +7,12 @@ To be qualified as a gemlog file, the file must be:
* filename must start with a date in YYYY-MM-DD format;
* first line must contain a #HEADER used as link name.
USAGE EXAMPLES
## USAGE EXAMPLES
```
gemlog_index . | sort
Add an alias to your .bash_aliases to index and prepend a header file
alias gemlog='cat header.txt <(~/bin/gemlog_index . | sort -r ) > index.gmi'
```