From 963265788a066c39a1b9d8979d15bdcae1f1e9c8 Mon Sep 17 00:00:00 2001
From: Wytamma Wirth <wytamma.wirth@me.com>
Date: Sat, 7 Aug 2021 15:46:32 +1000
Subject: [PATCH] :art: pypi readme

---
 backend/PYPI-README.md | 34 ++++++++++++++++++++++++++++++++++
 backend/pyproject.toml |  2 +-
 2 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 backend/PYPI-README.md

diff --git a/backend/PYPI-README.md b/backend/PYPI-README.md
new file mode 100644
index 0000000..c23103e
--- /dev/null
+++ b/backend/PYPI-README.md
@@ -0,0 +1,34 @@
+![beastiary logo](docs/images/logo.png)
+
+
+[![PyPi](https://img.shields.io/pypi/v/beastiary.svg)](https://pypi.org/project/beastiary/)
+[![tests](https://github.com/Wytamma/beastiary/actions/workflows/test.yml/badge.svg)](https://github.com/Wytamma/beastiary/actions/workflows/test.yml)
+[![cov](https://codecov.io/gh/Wytamma/beastiary/branch/master/graph/badge.svg)](https://codecov.io/gh/Wytamma/beastiary)
+[![docs](https://github.com/Wytamma/beastiary/actions/workflows/docs.yml/badge.svg)](https://beastiary.wytamma.com/)
+
+This is a replacement for tracer. It's feature feature is the real time aspect. Secondly it's modern looking. 3rd it has improved features. 
+
+
+## CLI
+Launch the app
+Can point to log file to autostart watcher
+
+## Webapp 
+Vue
+Plotly
+
+## Web API
+FastAPI that sends data to and from DB and servers the webapp
+Can start file watchers
+
+## Watcher 
+Python class that watches files and updates DB with changes.
+
+
+## BD (MEMORY)
+Protected by the CRUD
+
+
+## distribution 
+CLI vs app (just launches web browser)
+https://docs.python-guide.org/shipping/freezing/
diff --git a/backend/pyproject.toml b/backend/pyproject.toml
index 6af5f0b..23113ed 100644
--- a/backend/pyproject.toml
+++ b/backend/pyproject.toml
@@ -3,7 +3,7 @@ name = "beastiary"
 version = "0.4.0"
 description = ""
 authors = ["Wytamma Wirth <wytamma.wirth@me.com>"]
-readme = "../README.md"
+readme = "PYPI-README.md"
 
 [tool.poetry.scripts]
 beastiary = "backend.beastiary.main:app"