summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDylan Araps <dylan.araps@gmail.com>2017-07-23 19:27:54 +1000
committerDylan Araps <dylan.araps@gmail.com>2017-07-23 19:27:54 +1000
commitcca8b1752b88739dc539335d1ad2190c3312297b (patch)
treee41243f72246beca2c47956afb330f2909af37e8
parentf13a0c28fd27dc0238103a0a750b8f88c5eac804 (diff)
docs: README
-rw-r--r--README.md17
1 files changed, 2 insertions, 15 deletions
diff --git a/README.md b/README.md
index ebb0f1f..2730a7c 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
[![PyPI](https://img.shields.io/pypi/v/pywal.svg)](https://pypi.python.org/pypi/pywal/) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Build Status](https://travis-ci.org/dylanaraps/pywal.svg?branch=master)](https://travis-ci.org/dylanaraps/pywal)
+\[[Installation](https://github.com/dylanaraps/pywal/wiki/Installation)\] \[[Getting Started](https://github.com/dylanaraps/pywal/wiki/Getting-Started)\] \[[Customization](https://github.com/dylanaraps/pywal/wiki/Customization)\]
+
`wal` is a script that takes an image (or a directory of images), generates a colorscheme (using `imagemagick`) and then changes all of your open terminal's colors to the new colorscheme on the fly. `wal` then caches each generated colorscheme so that cycling through wallpapers while changing colorschemes is instantaneous.
`wal` also merges the new colorscheme into the Xresources database so that programs on your system such as `Rofi` or `i3` use the new colors automatically. `wal` finally exports the colors into various formats so that you can use the colors in webpages, scripts, other programs etc.
@@ -15,18 +17,3 @@ For more info, check out the [Wiki](https://github.com/dylanaraps/pywal/wiki).
[Albums of examples (Warning large)](https://dylanaraps.com/pages/rice)
![screenshot](https://i.imgur.com/hkAJjJg.png)
-
-
-## Installation
-
-https://github.com/dylanaraps/pywal/wiki/Installation
-
-
-## Getting Started
-
-https://github.com/dylanaraps/pywal/wiki/Getting-Started
-
-
-## Customization
-
-https://github.com/dylanaraps/pywal/wiki