aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCody Logan <clpo13@gmail.com>2020-01-07 16:38:23 -0800
committerCody Logan <clpo13@gmail.com>2020-01-07 16:38:23 -0800
commitaec984ee9dbcd14856c189eee12106753b1be9c1 (patch)
treefc6962d38dcf82b2d4c8ae9d32f4788179b8a6de /README.md
parent99c468ebdfcf3020e5589907f8b4da8acd5836ec (diff)
downloadalphanum-aec984ee9dbcd14856c189eee12106753b1be9c1.tar.gz
alphanum-aec984ee9dbcd14856c189eee12106753b1be9c1.zip
Update README with installation instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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