From a234b458025df767c345a5d253b2344ba054177e Mon Sep 17 00:00:00 2001
From: dtomlinson <dtomlinson@panaetius.co.uk>
Date: Mon, 13 Jan 2020 23:41:50 +0000
Subject: [PATCH] adding new README.rst to replace the .md

---
 .DS_Store                  | Bin 0 -> 6148 bytes
 README.md => README.md.old |   0
 README.rst                 |  46 +++++++++++++++++++++++++++++++++++++
 pyproject.toml             |   4 ++--
 4 files changed, 48 insertions(+), 2 deletions(-)
 create mode 100644 .DS_Store
 rename README.md => README.md.old (100%)
 create mode 100644 README.rst

diff --git a/.DS_Store b/.DS_Store
new file mode 100644
index 0000000000000000000000000000000000000000..c88a062b05be4fd1d362b3e4c6a7481e718b69d0
GIT binary patch
literal 6148
zcmeH~O$x$5422WzLU7Zi%h`AUZ!n0Spcima5J4*Vx1OW>k_m#<wTQex@+O%HrQf2{
zh={Il{Ys=2kr~`nmKH{)$Q$Y9AQ!pbyYp~74SUqAK8drohPN`>k8KJGkN^pg011%5
z4-v3?8#bF)Wh4O-Ab}?V`#vPNX$~z_{nLTqBLK8P*$r!-C7{U)&>UK-q5{*H9yD6j
z#}KP~J2b_)99pW@cF`C<G@h(B#lW<-izXy6%`OZiKmsEI)0($-|8L=+=KoO(QxYJ7
zKO>;crrWIXQgOGwy`I%~QMGk}L;X0y%TE9jyNVZZH|!@{KyzrRiVBQB0*--!1inh(
E0rZ6u#{d8T

literal 0
HcmV?d00001

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 <dtomlinson@panaetius.co.uk>"]
-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"