Include Zenodo DOI. Bumped minor version. Nicer README.

solarchemist · Mar 16, 2023 · 75afea7 · 75afea7
1 parent 83121ca
commit 75afea7
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 4 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -3,8 +3,8 @@ message: 'To cite the xraylines package in publications, please use the metadata
 type: software
 license: GPL-3.0-or-later
 title: 'Combined dataset of elemental X-ray line properties'
-version: 0.1.0.9000
-# doi:
+version: 0.1.1.9000
+doi: https://doi.org/10.5281/zenodo.7742595
 abstract: Dataset of X-ray line (transition) and edge energies, natural line
   widths, and fluorescence yields for the elements Z=4 (Be) to Z=103 (Lr).
   This package also provides a matching algorithm that given a set of energies

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: xraylines
 Type: Package
 Title: Combined Dataset of Elemental X-ray Line Properties
-Version: 0.1.0.9000
+Version: 0.1.1.9000
 Author: Taha Ahmed
 Maintainer: Taha Ahmed <taha@chepec.se>
 Description: Dataset of X-ray line (transition) and edge energies, natural line

diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![DOI](https://zenodo.org/badge/615039897.svg)](https://zenodo.org/badge/latestdoi/615039897)
+
 # Combined dataset of elemental X-ray line properties
 
 This R package contains a dataset of X-ray line (transition) and edge energies,
@@ -34,7 +36,7 @@ I suggest the following package rebuild procedure:
 + Run `devtools::check()` (use `document=TRUE` to also update the docs).
   Should complete with no warnings or errors, and 2 notes:
 ```
-── R CMD check results ──────────────────── xraylines 0.1.0.9000 ────
+── R CMD check results ──────────────────── xraylines 0.1.1.9000 ────
 Duration: 12.7s
 
 ❯ checking top-level files ... NOTE
@@ -52,3 +54,21 @@ Duration: 12.7s
   and populates the `doc/` directory.
 + Manually remove the line `doc` from `.gitignore` because we want the built
   vignette to be available on the remote repo (the build step keeps adding this line).
+
+
+## Contributions welcome!
+
+[Open an issue](https://github.com/solarchemist/xraylines/issues) or
+[contact me](https://solarchemist.se/contact/) with your bug reports and any feedback.
+
+
+
+## Citation
+
+To cite `xraylines` in publications use:
+
+Taha Ahmed (2023). Combined dataset of elemental X-ray line properties.
+DOI: [10.5281/zenodo.7742595 ](https://doi.org/10.5281/zenodo.7742595 ).
+
+Or see the `CITATION.cff` file in this repo
+([learn about CFF](https://citation-file-format.github.io)).