Merge pull request #65 from nhs-r-community/update-readme

Added remotes to package installation prompt and updated contributing…

README.md

@@ -12,18 +12,26 @@
 An R-package to implement the waiting list management approach described in the paper [Understanding Waiting Lists Pressures](https://www.medrxiv.org/content/10.1101/2022.08.23.22279117v1) by Fong et al.
 
 
-## To install the package, run:
-``` r
+# Installation 
+
+You can install the current version of {name of package} from GitHub with:
+
+```{r}
+
+# install.packages("remotes")
 remotes::install_github("nhs-r-community/NHSRwaitinglist", build_vignettes = TRUE)
+
 ```
 
+## Contributing
 
-## Contribution
+If you want to learn more about this project, please join the discussion at the [NHS-R Community Slack](https://nhsrway.nhsrcommunity.com/community-handbook.html#slack) group and the specific channel #managing-waiting-lists.
 
-This is an NHS-R Community project that is open for anyone to contribute to in any way that they are able. Please see the [NHS-R Way](https://nhsrway.nhsrcommunity.com/style-guides.html) to read more on the style guides and for [Code of Conduct](https://nhsrway.nhsrcommunity.com/code-of-conduct.html) related to any activity or contribution to the NHS-R Community as well as the Code of Conduct in this repository which is generated using `usethis::use_code_of_conduct(contact = "[email protected]")`.
-By contributing to this project, you agree to abide by these terms.
+Please see our 
+[guidance on how to contribute](https://tools.nhsrcommunity.com/contribution.html).
 
-If you want to learn more about this project, please join the discussion at the [NHS-R Community Slack](https://nhsrway.nhsrcommunity.com/community-handbook.html#slack) group and the specific channel #managing-waiting-lists.
+This project is released with a Contributor [Code of Conduct](./CODE_OF_CONDUCT.md). 
+By contributing to this project, you agree to abide by its terms.
 
 The simplest way to contribute is to raise an issue detailing the feature or functionality you would like to see added, or any unexpected behaviour or bugs you have experienced.
 
@@ -35,4 +43,5 @@ You are welcome to also submit Pull Requests and, as the `main` branch is protec
 * Commit to the new branch (add code or delete code or make changes)
 * Push the commits 
 * Create a pull-request in GitHub to signal that your work is ready to be merged
-* Tag one or more reviewers so that your contribution can be reviewed and merged into `main`
+* Tag one or more reviewers (@ThomUK and @ChrisMainey) so that your contribution can be reviewed and merged into main
+