From ca812c06c545ed4de8dec132dd502cf910af08ee Mon Sep 17 00:00:00 2001 From: randogoth Date: Sat, 3 Jun 2023 11:41:24 +0300 Subject: [PATCH] updated docu --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4eb5706..7878e2a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,13 @@ [![PyPI version](https://badge.fury.io/py/randonautentropy.svg)](https://pypi.org/project/randonautentropy/) [![PyPI - License](https://img.shields.io/pypi/l/randonautentropy)](https://pypi.org/project/randonautentropy/) -This project provides tools for interacting with the Randonautica Quantum and Temporal entropy generators. It provides a Python API, and a `rndo` command-line tool. +This project provides tools for interacting with the Randonautica QRNG and [Temporal](https://github.com/TheRandonauts/temporal) entropy generators. It provides a Python API, and a `rndo` command-line tool. + +### Fair Use Policy + +Please request only the entropy amount you really need for your project. Please note that in case of overuse the API is subject to immediate modifications and amendments to free availability. + +Temporal on the other hand runs on your system and is always available. ## Installation @@ -10,6 +16,19 @@ This project provides tools for interacting with the Randonautica Quantum and Te $ pip install randonautentropy ``` +### Installing Temporal + +The first time the `temporal.get` Python method or `rndo -t` command line option are called, a script attempts to automatically install the [TemporalLib](https://github.com/TheRandonauts/temporal) shell tool dependency in `/usr/local/bin` + +In case that fails you can install it yourself: + +``` +$ sudo apt install git build-essential +$ git clone --depth 1 git@github.com:TheRandonauts/temporal.git +$ cd temporal +$ ./make.sh +``` + --- ## Python API