Merge pull request #25 from VirtualPlanetaryLaboratory/readme

Updated Readme.

Author: RoryBarnes

.github/workflows/tests.yml

@@ -19,7 +19,8 @@ jobs:
           activate-environment: vplot
           environment-file: environment.yml
 
-      - name: Install vplanet-private pre-release
+      # TODO: Remove this step in production
+      - name: Install vplanet
         shell: bash -l {0}
         env:
           ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

README.md

@@ -1,19 +1,22 @@
 <p align="center">
   <img width = "200" src="https://github.com/VirtualPlanetaryLaboratory/vplot/blob/dev/docs/vplot.svg"/>
-  <br/>
-  <b>vplot |</b> plotting utilities for <a href="https://github.com/VirtualPlanetaryLaboratory/vplanet">VPLanet</a>
-  <p align="center">
-    <!-- main tests -->
-    <a href="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/tests.yml">
-      <img src="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/tests.yml/badge.svg"/>
-    </a>
-    <!-- build docs -->
-    <a href="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/docs.yml">
-      <img src="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/docs.yml/badge.svg"/>
-    </a>
-    <!-- read the docs -->
-    <a href="https://virtualplanetarylaboratory.github.io/vplot/">
-      <img src="https://img.shields.io/badge/read-the%20docs-blue.svg?style=flat"/>
-    </a>
-  </p>
 </p>
+<br/>
+<h1 align="center">VPLot: Plotting Utilities for VPLanet</h1>
+<p align="center">
+<!-- read the docs -->
+  <a href="https://virtualplanetarylaboratory.github.io/vplot/">
+    <img src="https://img.shields.io/badge/read-the%20docs-blue.svg?style=flat"/>
+  </a>
+  <!-- build docs -->
+  <a href="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/docs.yml">
+    <img src="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/docs.yml/badge.svg"/>
+  </a>
+  <!-- main tests -->
+  <img src="https://img.shields.io/badge/Unit%20Tests-11-darkblue.svg"/></a>
+  <a href="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/tests.yml">
+    <img src="https://github.com/VirtualPlanetaryLaboratory/vplot/actions/workflows/tests.yml/badge.svg"/>
+  </a>   
+</p>
+<br>
+VPLot simplifies plotting [VPLanet](https://github.com/VirtualPlanetaryLaboratory/vplanet) data through a command line option that instantly generates plots of a single simulation, as well as a Python module to generate consistent and accessible figures for your publications.