Document cli utility - Githubissues

houfu / redlines

Show the differences between two strings/text as a compact text, in markdown/HTML, in the terminal and more.

https://houfu.github.io/redlines/

MIT License

110 stars 6 forks source link

Document cli utility #38

Open houfu opened 17 hours ago

houfu commented 17 hours ago

Currently the cli utility is excluded from documentation (see redlines/init.py) It would be good to document the utility as someone may want to use it in the terminal.

[ ] Include cli in all
[ ] Describe text command
[ ] Note limitation on long text (see #37 )
[ ] Mention houfu/redlines-textual project as alternative
[ ] Mention cli command in first page of docs