starting to wrap up a production release

README.md

@@ -6,7 +6,7 @@ version | DOI
 --------|------
 1.2     | 10.5281.zenodo.9887
 
-# Efficiency Tracker
+# Efficiency Calculator
 
 The Efficiency Calculator summarizes the results of a series of GEANT 4 simulations of the GRIFFIN detector and several ancillary detectors, by visualizing efficiency curves and calculating predicted efficiencies for photons and electrons under an array of experimental conditions.
 
@@ -20,4 +20,17 @@ This project uses [Dygraphs](http://dygraphs.com/) for plotting, and [Twitter Bo
 
  - **Setup**: on page load, parameters from the GEANT simulation are loaded from `fitParams.js`, `fitParamsSCEPTAR.js`, and `fitParamsLaBr.js`. These parameters are the coefficients of 8th order polynomials, fit to efficiency as a function of ln(gamma energy) or ln(beta Q). The rest of `setup()` plugs in callbacks and UI.
  - **Plot updating**: whenever any plot control UI is changed, `chooseGraphs()` and / or `chooseBetaGraphs()` call a series of functions to read the new UI parameters, use them to select the appropriate set of fit parameters loaded by `setup()`, and re-draw the dygraphs.
- - **Rate Calculators** provide efficiency and rate estimates for singles, coincidences and triples; their behavior is governed by `computeSingles()`, `computeCoincidence()` and `computeTriples()`. 
+ - **Rate Calculators** provide efficiency and rate estimates for singles, coincidences and triples; their behavior is governed by `computeSingles()`, `computeCoincidence()` and `computeTriples()`.
+
+## Contributing
+
+Contributions are very welcome! If you have an idea, question or comment, please open an issue. If you would like to make a change to the Efficiency Calculator, please follow these steps:
+ - start by opening an issue or empty PR to discuss your ideas
+ - please limit individual PRs to less than 500 lines.
+ - please encapsulate all new behavior wherever possible in functions of 50 lines or less each.
+
+## Citation & Deployment
+
+If you use a result from the Efficiency Calculator, **be sure to site it using the correct DOI**. This will allow you to go back and reproduce your results later, with the same version of the Calculator you used originally. To find the correct DOI, look in the footer of the app.
+
+If you push changes to the Efficiency Calculator onto GRIFFIN's live toolkit, **be sure to update the DOI in the footer**. To get a new DOI, simply [make a new release via GitHub](https://help.github.com/articles/creating-releases/). The DOI badge at the top of this README will automatically update with the new number; copy it into the footer before deploying live.