adding new README.rst to replace the .md

This commit is contained in:
2020-01-13 23:41:50 +00:00
parent a1dd396fd4
commit a234b45802
4 changed files with 48 additions and 2 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

46
README.rst Normal file
View File

@@ -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
==============

View File

@@ -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"