Add information on how to cite the project

RainCloudPlots · Aug 17, 2018 · e709e41 · e709e41
1 parent 32db14a
commit e709e41
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Micah Allen, Davide Poggiali, Kirstie Whitaker, Tom Rhys Marshall and Rogier Kievit
+Copyright (c) 2018 Micah Allen, Davide Poggiali, Kirstie Whitaker, Tom Rhys Marshall and Rogier Kievit.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@ Code and tutorials to visualise your data that is both beautiful *and* statistic
 
 * [Read the preprint](#read-the-preprint)
 * [Give us feedback](#give-us-feedback)
+* [Citing raincloud plots](#citing-rain-cloud-plots)
 * [Interactive tutorials online](#interactive-tutorials-online)
 * [Installing and running on your local machine](#installing-and-running-on-your-local-machine)
   * [Download from github](#download-from-github) (needed for all tutorials)
@@ -27,6 +28,14 @@ We'd love to hear your thoughts and any feedback you have. The best place to lea
 
 You can also submit a pull request to this repository if you find a bug! Just check out our [contributing guidelines](CONTRIBUTING.md) for help getting started.
 
+## Citing RainCloudPlots
+
+We really hope you find these tutorials helpful and want to use the code in your next paper or presentation! This repository is made available under the [MIT license](LICENSE) which means you're welcome to use and remix the contents so long as you credit the creators: Micah Allen, Davide Poggiali, Kirstie Whitaker, Tom Rhys Marshall and Rogier Kievit.
+
+We will add a zenodo archive of the codebase when our publication has been peer reviewed. For now, please cite the preprint, and get in touch with [Kirstie Whitaker](https://github.com/KirstieJane) if you need help citing a particular version of this codebase.
+
+> ***add citation***
+
 ## Interactive tutorials online
 
 You don't have to take our word for it, you can use Project Jupyter's [binder](https://mybinder.org) to interact with the python and R tutorials yourself.