From ff913c8cf75b9137be69e3e30239e68b7a6f12e8 Mon Sep 17 00:00:00 2001 From: Piotr Pasza Storozenko Date: Tue, 30 Apr 2024 15:22:37 +0200 Subject: [PATCH] docs: change readme --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1baedd1..9d0fd3a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,13 @@ -# Tapyr - Shiny for Python Application TemplateTapyr logo +# Respiratory Disease: Tapyr Version -> Create and deploy enterprise-ready PyShiny dashboards with ease. +This repository contains the tapyr migration of [stock-app](https://shiny.posit.co/py/templates/stock-app/), a template app from [shiny templates](https://shiny.posit.co/py/templates/). -## Introduction +## Explore the app +The app is deployed at [Appsilon Posit Connect](https://connect.appsilon.com/stock-app-tapyr/). -Tapyr is designed for data scientists and developers seeking a seamless transition from development to deployment, this template uses `poetry` for dependency management and `pytest`/`playwright` for comprehensive app validation/testing/quality assurance. -Ideal for projects aiming for high-quality code and efficient deployment on Posit Connect. - -## Docs - -For comprehensive documentation, please visit our [documentation TODO](TODO). - -## Getting Started - -Check out our get started with `tapyr` [blog post](TOOD). +## How to run +(This section is copied from the tapyr template) ### Using Devcontainer To ensure a consistent development experience across all environments, we recommend using the [devcontainer](https://code.visualstudio.com/docs/remote/containers) configuration with Visual Studio Code or DevPod for container-based development.