update docs

README.md

@@ -26,6 +26,10 @@ renv::install("raeslab/LRdbRDA")
 
 ## Usage
 
+To run RLdbRDA two dataframes are needed: one with the microbial abundances and one with metadata. In both cases rows should be samples/subject and columns microbiota and metadata features respectively. 
+
+Off note, it is strongly recommended to **remove strongly correlated features from the metadata** before running RLdbRDA. Furthermore, RLdbRDA cannot handle missing values in the metadata. **Features with many missing values should be excluded** first, next **samples/subjects with incomplete cases should be removed** (or imputed if possible).
+
 ### Example
 
 ```R
@@ -47,4 +51,13 @@ g
 
 ![bar plot showing the single and cumulative effect of various features on the varespec dataset included in vegan](./docs/img/rldbrda_example_output.png)
 
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+  * Found a bug or have some suggestions? Open an [issue](https://github.com/raeslab/RLdbRDA/issues).
+  * Pull requests are welcome! Though open an [issue](https://github.com/raeslab/RLdbRDA/issues) first to discuss which features/changes you wish to implement.
+
+## Contact
 
+RLdbRDA was developed by [Sebastian Proost](https://sebastian.proost.science/) at the [RaesLab](https://raeslab.sites.vib.be/en) and was adopted from code written by [Sara Vieira-Silva](https://saravsilva.github.io/).