tldrx 0.1.0

A tldr pages client support private pages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# TLDRx

[![GitHub CI](https://github.com/tldrx/tldrx/actions/workflows/ci.yml/badge.svg)](https://github.com/tldrx/tldrx/actions/workflows/ci.yml)


<img src="docs/screenshot.png" alt="screenshot" width="582">


## Usages

Show pages for `git commit`:

    tldrx git commit

Update local cache(Required for the first time before showing official pages):

    tldrx --update

Edit or create private page for `git commit`:

    tldrx -e git commit

For more:

    tldrx --help


## Installation

Assume you have rust cargo installed:

    cargo install tldrx


## License

This project is dual-licensed under [MIT](LICENSE-MIT) license and [MulanPSL-2.0](LICENSE-MulanPSL) license.
You can freely choose one or the other that suits you.