From aec984ee9dbcd14856c189eee12106753b1be9c1 Mon Sep 17 00:00:00 2001 From: Cody Logan Date: Tue, 7 Jan 2020 16:38:23 -0800 Subject: Update README with installation instructions --- README.md | 14 ++++++++++++++ pyproject.toml | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cab856e..77e9661 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,20 @@ Simple Python library to generate pseudo-random alphanumeric strings of arbitrary length. Requires Python 3.6+. +## Installation + +alphanum can be obtained from PyPI with `pip install alphanum`. + +Alternatively, build it with [Poetry](https://python-poetry.org/): + +```bash +pip install poetry +git clone https://github.com/clpo13/alphanum +cd alphanum +poetry build +pip install dist/alphanum-x.y.z-py3-none-any.whl +``` + ## Usage ```python diff --git a/pyproject.toml b/pyproject.toml index 40ae630..8c2e81a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ authors = ["Cody Logan "] license = "MIT" readme = "README.md" homepage = "https://github.com/clpo13/alphanum" -repository = "https://github.com/clpo13/repository" +repository = "https://github.com/clpo13/alphanum" keywords = ['string', 'random', 'pseudo-random', 'generator'] [tool.poetry.dependencies] -- cgit v1.2.3