aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCody Logan <clpo13@gmail.com>2020-01-07 16:28:01 -0800
committerCody Logan <clpo13@gmail.com>2020-01-07 16:28:01 -0800
commitc77d4fc27a7235f206e2ae771c47a57d6cc18df4 (patch)
treea113121533acd7cd0697760f1282a3df4f232be6 /README.md
downloadalphanum-0.1.0.tar.gz
alphanum-0.1.0.zip
Initial commitv0.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cab856e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# alphanum
+
+Simple Python library to generate pseudo-random alphanumeric strings of
+arbitrary length. Requires Python 3.6+.
+
+## Usage
+
+```python
+import alphanum
+
+foo = alphanum.generate(10)
+print(foo)
+```
+
+## License
+
+Copyright (c) 2020 Cody Logan. MIT licensed.