intro to deepdiagnostics

README.md

@@ -1,21 +1,12 @@
-This template is designed to give a framework for public distributions of "science" projects. 
-It is a guideline, showing the minimum things recommended to include with your public repository, 
-to make your results easily replicable. 
-It is not exhaustive by any means, nor is everything here strictly required in all cases! 
-Please consider this as a loose list of things considered "nice to have", and as reference material above all. 
-
-# DeepSkies Science Repo Template 
-Include status links to different outside resources, such as build info, paper info, license, etc. 
-You can select your license from the [choose a license page.](https://choosealicense.com/licenses/), and then change the name of the license in the badge and link included. 
-For workflows, change the name of the repo listed in the img.shields link to point to your repo and workflows.
-
+# DeepDiagnostics
+DeepDiagnostics is a package for diagnosing the posterior from an inference method. It is flexible, applicable for both simulation-based and likelihood-based inference.
 [![status](https://img.shields.io/badge/arXiv-000.000-red)](arxiv link if applicable)
 [![status](https://img.shields.io/badge/PyPi-0.0.0.0-blue)](pypi link if applicable)
 [![status](https://img.shields.io/badge/License-MIT-lightgrey)](MIT or Apache 2.0 or another requires link changed)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/owner/repo/build-repo)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/owner/repo/test-repo?label=test)
 
-Your overview should contain a brief summary of the project, and figures and examples showing input and output. 
+## Workflow
 
 ## Installation 
 Information about install.