diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..c88a062 Binary files /dev/null and b/.DS_Store differ diff --git a/README.md b/README.md.old similarity index 100% rename from README.md rename to README.md.old diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..2487dec --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +Author +======= + +Daniel Tomlinson (dtomlinson@panaetius.co.uk) + +Requires +========= + +`>= python3.7` + +Python requirements +==================== + +- toml = "^0.10.0" +- pylite = "^0.1.0" + +Documentation +============== + +Read the documentation on `read the docs`_. + +.. _read the docs: https://panaetius.readthedocs.io/en/latest/introduction.html + +Installation +============== + +You can install ..:obj:`panaetius` + +Easy Way +========= + +Python +------- + +From pip +~~~~~~~~~ + +From local wheel +~~~~~~~~~~~~~~~~~ + +From source +~~~~~~~~~~~~ + +Example Usage +============== + diff --git a/pyproject.toml b/pyproject.toml index ef21c25..e85d398 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,10 @@ [tool.poetry] name = "panaetius" -version = "1.0.1" +version = "1.0.2" description = "Python module to gracefully handle a .config file/environment variables for scripts, with built in masking for sensitive options. Provides a Splunk friendly logger instance." license = "MIT" authors = ["dtomlinson "] -readme = "/Users/dtomlinson/git-repos/projects/panaetius/README.md" +readme = "/Users/dtomlinson/git-repos/projects/panaetius/README.rst" homepage = "https://github.com/dtomlinson91/panaetius" repository = "https://github.com/dtomlinson91/panaetius" documentation = "https://panaetius.readthedocs.io/en/latest/introduction.html"