Skip to content

Commit acded10

Browse files
README: minor fixes
1 parent baf2a7d commit acded10

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,29 @@
33
[![PyPI Release](https://img.shields.io/pypi/v/tldr.svg)](https://pypi.python.org/pypi/tldr)
44
[![Build Status](https://travis-ci.org/tldr-pages/tldr-python-client.svg?branch=master)](https://travis-ci.org/tldr-pages/tldr-python-client)
55

6-
A `Python` command line client for [tldr](https://github.com/tldr-pages/tldr).
6+
Python command-line client for [tldr pages](https://github.com/tldr-pages/tldr).
77

88
![tldr screenshot](http://raw.github.com/tldr-pages/tldr/master/images/screenshot.png)
99

1010
## Installation
1111

1212
### from PyPI
1313

14-
pip install tldr
14+
```bash
15+
pip install tldr
16+
```
1517

1618
### from Arch Linux repository
1719

18-
sudo pacman -S tldr
20+
```bash
21+
sudo pacman -S tldr
22+
```
1923

2024
### from Fedora packages repository
2125

22-
sudo dnf install tldr
26+
```bash
27+
sudo dnf install tldr
28+
```
2329

2430
## Usage
2531

@@ -51,15 +57,17 @@ optional arguments:
5157

5258
You can configure the behavior and output of the `tldr` client by setting environment variables. For example, in the `.bashrc` file:
5359

54-
export TLDR_COLOR_NAME="cyan"
55-
export TLDR_COLOR_DESCRIPTION="white"
56-
export TLDR_COLOR_EXAMPLE="green"
57-
export TLDR_COLOR_COMMAND="red"
58-
export TLDR_COLOR_PARAMETER="white"
59-
export TLDR_CACHE_ENABLED=1
60-
export TLDR_CACHE_MAX_AGE=720
61-
export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
62-
export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"
60+
```bash
61+
export TLDR_COLOR_NAME="cyan"
62+
export TLDR_COLOR_DESCRIPTION="white"
63+
export TLDR_COLOR_EXAMPLE="green"
64+
export TLDR_COLOR_COMMAND="red"
65+
export TLDR_COLOR_PARAMETER="white"
66+
export TLDR_CACHE_ENABLED=1
67+
export TLDR_CACHE_MAX_AGE=720
68+
export TLDR_PAGES_SOURCE_LOCATION="https://raw.githubusercontent.com/tldr-pages/tldr/master/pages"
69+
export TLDR_DOWNLOAD_CACHE_LOCATION="https://tldr-pages.github.io/assets/tldr.zip"
70+
```
6371

6472
### Cache
6573

0 commit comments

Comments
 (0)