Merge pull request #59 from CCBR/iss-58

Create development roadmap diagram

README.Rmd

@@ -32,6 +32,7 @@ You can install the development version of reneeTools from [GitHub](https://gith
 devtools::install_github("CCBR/reneeTools")
 ```
 
+<!--
 ## Example
 
 TODO: This is a basic example which shows you how to solve a common problem:
@@ -40,3 +41,19 @@ TODO: This is a basic example which shows you how to solve a common problem:
 library(reneeTools)
 ## basic example code
 ```
+-->
+
+## Help & Contributing
+
+Come across a **bug**? Open an [issue](https://github.com/CCBR/reneeTools/issues) and include a minimal reproducible example.
+
+Have a **question**? Ask it in [discussions](https://github.com/CCBR/reneeTools/discussions).
+
+Want to **contribute** to this project? Check out the [contributing guidelines](.github/CONTRIBUTING.md).
+
+## Development Roadmap
+
+![](./man/figures/reneeTools-development-plan.png)
+
+- [dev spreadsheet](https://nih-my.sharepoint.com/:x:/g/personal/homanpj_nih_gov/ETvHXgnwxExEpcP57Jj9_EwBHBvZBqNuZ_c3eu51w-SlnA?e=PcXKU8)
+- [project board](https://github.com/orgs/CCBR/projects/32)

README.md

@@ -1,3 +1,4 @@
+
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
 # reneeTools
@@ -16,17 +17,37 @@ sequencing analysis pipeline
 You can install the development version of reneeTools from
 [GitHub](https://github.com/) with:
 
-```r
+``` r
 # install.packages("devtools")
 devtools::install_github("CCBR/reneeTools")
 ```
 
+<!--
 ## Example
-
-TODO: This is a basic example which shows you how to solve a common
-problem:
-
-```r
+&#10;TODO: This is a basic example which shows you how to solve a common problem:
+&#10;
+``` r
 library(reneeTools)
 ## basic example code
 ```
+-->
+
+## Help & Contributing
+
+Come across a **bug**? Open an
+[issue](https://github.com/CCBR/reneeTools/issues) and include a minimal
+reproducible example.
+
+Have a **question**? Ask it in
+[discussions](https://github.com/CCBR/reneeTools/discussions).
+
+Want to **contribute** to this project? Check out the [contributing
+guidelines](.github/CONTRIBUTING.md).
+
+## Development Roadmap
+
+![](./man/figures/reneeTools-development-plan.png)
+
+- [dev
+  spreadsheet](https://nih-my.sharepoint.com/:x:/g/personal/homanpj_nih_gov/ETvHXgnwxExEpcP57Jj9_EwBHBvZBqNuZ_c3eu51w-SlnA?e=PcXKU8)
+- [project board](https://github.com/orgs/CCBR/projects/32)