updated readme

master
Gregory Scheerlinck 8 years ago
parent a94a9c9386
commit 8689398226

@ -1,13 +1,47 @@
A tool to browse and search a constantly updated local copy of the entire Arch Wiki on the command line using `man`.
# Screenshot
![example](./docs/awman.gif)
With colors (this depends on your own configuration) and showing off language support:
![example](./docs/awman2.gif)
# Installation
```
npm install -g arch-wiki-man
```
Or you can also install it [through the AUR](https://aur.archlinux.org/packages/arch-wiki-man/). For example, using yaourt:
```
yaourt -S arch-wiki-man
```
# Updating through npm
## npm
Just reinstall the package:
```
npm install -g arch-wiki-man
```
Or you can also install it [through the AUR](https://aur.archlinux.org/packages/arch-wiki-man/)
Updates are pushed automatically every two days to `https://github.com/greg-js/arch-wiki-md-repo`, a dependency for this project. Whenever the install command is run, arch-wiki-man will fetch the changes from arch-wiki-md-repo, giving you access to the latest changes.
## yaourt
Just reinstall the package (see paragraph above for explanation):
```
yaourt -S arch-wiki-man
```
Of course you don't *have* to use yaourt for reinstalling the package, this is just an example. Use any helper you want or compile the AUR package yourself.
# Usage & Examples
@ -51,6 +85,10 @@ awman -w tmux
The `-w` or `--web` option opens the resulting match in a web browser rather than with `man`. It uses `xdg-open` to open the relevant url in your default browser.
![example](./docs/awman3.gif)
(sorry for the bad resolution in this screenshot)
## Search in other languages
```
@ -65,24 +103,6 @@ If your search fails to find any results, `awman` will automatically fall back t
Simply do a `ctrl-c` to exit the selection menu without entering `man`. To exit `man`, press `q`.
# Updating through npm
Just reinstall the package:
```
npm install -g arch-wiki-man
```
Updates are pushed automatically every two days to `https://github.com/greg-js/arch-wiki-md-repo`, a dependency for this project. Whenever the install command is run, arch-wiki-man will fetch the changes from arch-wiki-md-repo, giving you access to the latest changes.
# Updating using yaourt
Just reinstall the package (see paragraph above for explanation):
```
yaourt -S arch-wiki-man
# License
Licensed under GPLv3

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 498 KiB

Loading…
Cancel
Save