Update docs files

CDCgov · Jun 22, 2023 · b3fd92b · b3fd92b
1 parent ca76a0d
commit b3fd92b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 9 deletions.
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -5,19 +5,19 @@ Installing pynssp
 =================
 
 
-.. Stable release
-.. --------------
+Stable release
+--------------
 
-.. To install pynssp, run this command in your terminal:
+To install pynssp, run this command in your terminal:
 
-.. .. code-block:: console
+.. code-block:: console
 
-..     $ pip install pynssp
+    $ pip install pynssp
 
-.. This is the preferred method to install pynssp, as it will always install the most recent stable release.
+This is the preferred method to install pynssp, as it will always install the most recent stable release.
 
-.. If you don't have `pip`_ installed, this `Python installation guide`_ can guide
-.. you through the process.
+If you don't have `pip`_ installed, this `Python installation guide`_ can guide
+you through the process.
 
 .. _pip: https://pip.pypa.io
 .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

diff --git a/docs/readme.md b/docs/readme.md
@@ -1,12 +1,24 @@
 # About pynssp 
 [![pynssp Pipeline](https://github.com/cdcent/pynssp/actions/workflows/check-standard.yaml/badge.svg)](https://github.com/cdcent/pynssp/actions/workflows/check-standard.yaml)
 [![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://github.com/CDCgov/pynssp)
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 ## Overview
 `pynssp` is a Python package for the National Syndromic Surveillance Program (NSSP) and its Community of Practice. A collection of classes and methods to advance the practice of Syndromic Surveillance. It serves as a Python alternative to the [Rnssp R package](https://cdcgov.github.io/Rnssp).
 
 ## Installation
 
+### Stable release
+
+To install `pynssp`, run this command in your terminal:
+
+```console
+$ pip install pynssp
+```
+
+This is the preferred method to install `pynssp`, as it will always install the most recent stable release.
+
+### Development version
+
 You can install the development version of `pynssp` from Github:
 
 ```console