From 7df479c59ea006ab4bfe6a1e62cf4c50524537cc Mon Sep 17 00:00:00 2001
From: profitroll <vozhd.kk@gmail.com>
Date: Thu, 10 Aug 2023 14:09:17 +0200
Subject: [PATCH] Improved README

---
 README.md | 53 ++++++++++++++---------------------------------------
 1 file changed, 14 insertions(+), 39 deletions(-)

diff --git a/README.md b/README.md
index c2d3f6d..b2ab0f9 100644
--- a/README.md
+++ b/README.md
@@ -11,54 +11,21 @@ Mastodon [huebot](https://botsin.space/@huebot).
 
 ## Installation
 
-### Nix
-
-This project is a [Nix Flake](https://nixos.wiki/wiki/Flakes). If you
-have a recent version of the [Nix package manager](https://nixos.org/)
-installed and Flakes are enabled, run huepaper like this:
-
-``` example
-nix run github:Deleh/huepaper
-```
-
-Parameters can be passed by appending a double-dash:
-
-``` example
-nix run github:Deleh/huepaper -- -hue 0.5 --color lightblue
-```
-
-Global installation can be done by including this flake in your flaked
-NixOS configuration as always :)
-
-### Legacy
-
-Execute the following steps to run huepaper:
-
-``` example
-pip install -r requirements.txt
-./huepaper.py
-```
-
-```{=org}
-#+end_example
-```
-
-To install it in your Python environment run:
-
-``` example
-python setup.py install
+```shell
+pip install --index-url https://git.end-play.xyz/api/packages/profitroll/pypi/simple/ huepaper
 ```
 
 ## Usage
 
-``` example
-usage: huepaper [-h] [-s SIZE] [-c COLOR] [-np] [-o OUTPUT] [-l [LINES]] [-lb [LINES_BRIGHT]] [-ld [LINES_DARK]] [-P [PIXELATE]] [-e EMBLEM] [-hue HUE] [-smin SMIN] [-smax SMAX] [-lmin LMIN] [-lmax LMAX]
+```example
+usage: huepaper [-h] [--width WIDTH] [--height HEIGHT] [-c COLOR] [-np] [-o OUTPUT] [-l [LINES]] [-lb [LINES_BRIGHT]] [-ld [LINES_DARK]] [-P [PIXELATE]] [-e EMBLEM] [-hue HUE] [-smin SMIN] [-smax SMAX] [-lmin LMIN] [-lmax LMAX]
 
 Create wallpapers based on color hues.
 
 optional arguments:
   -h, --help            show this help message and exit
-  -s SIZE, --size SIZE  size of huepaper in the form WIDTHxHEIGHT (default: 1920x1080)
+  --width WIDTH         width of the image (default: 1920)
+  --height HEIGHT       height of the image (default: 1080)
   -c COLOR, --color COLOR
                         base color from which the huepaper is generated (default: random color)
   -np, --no-preview     don't preview the huepaper
@@ -81,6 +48,14 @@ optional arguments:
   -lmax LMAX            maximum luminance for colors in range [0, 1] (default: 0.9)
 ```
 
+...or as a Python module
+
+```python
+from huepaper import generate
+
+image = generate(width=500, height=500, hue_max=1.0, lum_min=0.3, lum_max=0.6, sat_min=0.8, sat_max=1.0)
+```
+
 All image operations are called in order of the help file. E.g. pixelate
 (`-p`) is called after adding lines (`-l`).