Fixing README badges

NERC-CEH · Feb 12, 2024 · 1dd4b0a · 1dd4b0a
1 parent dee66ae
commit 1dd4b0a
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,17 @@
 
 
-[![GitHub
-Actions](https://github.com/ZekeMarshall/EcoVeg.jl/workflows/Run%20tests/badge.svg)](https://github.com/ZekeMarshall/EcoVeg.jl/actions?query=workflow%3ARun+tests)
+\[![version](https://img.shields.io/badge/version-0.1-blue)\]
+[![CI](https://github.com/JuliaCI/PkgTemplates.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ZekeMarshall/EcoVeg.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Codecov](https://codecov.io/gh/ZekeMarshall/EcoVeg.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ZekeMarshall/EcoVeg.jl)
 [![Aqua
 QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/ZekeMarshall/EcoVeg.jl)
 [![License](https://img.shields.io/github/license/ZekeMarshall/EcoVeg.jl)](LICENSE)
 
 # EcoVeg
 
-`EcoVeg.jl` is a package containing functions for the analysis of
-vegetation plot sample data….
+Tools for vegetation science.
+
+## Background
 
 in vegetation science using the Julia programming language (Bezanson et
 al. 2017)
@@ -20,22 +21,7 @@ Solves two language problem (Roesch et al. 2023)
 Aims to collate functionality found in JUICE, vegan, MAVIS into a single
 location with a user-friendly API and transparent methodologies.
 
-## Example Pluto Notebook
-
-### Local Tour
-
-To run the tour locally, just clone this repo and start `Pluto.jl` as
-follows:
-
-``` julia
-] add Pluto
-using Pluto
-Pluto.run()
-```
-
-All notebooks are contained in `docs/pluto`.
-
-## Background
+Nomenclature follows Theurillat et al. (2021).
 
 ## Installation
 
@@ -147,3 +133,9 @@ Roesch, Elisabeth, Joe G. Greener, Adam L. MacLean, Huda Nassar,
 Christopher Rackauckas, Timothy E. Holy, and Michael P. H. Stumpf. 2023.
 “Julia for Biologists.” *Nature Methods* 20 (5): 655–64.
 <https://doi.org/10.1038/s41592-023-01832-z>.
+
+Theurillat, Jean-Paul, Wolfgang Willner, Federico Fernández-González,
+Helga Bültmann, Andraž Čarni, Daniela Gigante, Ladislav Mucina, and
+Heinrich Weber. 2021. “International Code of Phytosociological
+Nomenclature. 4th Edition.” *Applied Vegetation Science* 24 (1): e12491.
+<https://doi.org/10.1111/avsc.12491>.
diff --git a/README.qmd b/README.qmd
@@ -15,7 +15,8 @@ bibliography: references.bib
 jupyter: julia-1.10
 ---
 
-[![GitHub Actions](https://github.com/ZekeMarshall/EcoVeg.jl/workflows/Run%20tests/badge.svg)](https://github.com/ZekeMarshall/EcoVeg.jl/actions?query=workflow%3ARun+tests)
+[![version](https://img.shields.io/badge/version-0.1-blue)]
+[![CI](https://github.com/JuliaCI/PkgTemplates.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ZekeMarshall/EcoVeg.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Codecov](https://codecov.io/gh/ZekeMarshall/EcoVeg.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ZekeMarshall/EcoVeg.jl)
 [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/ZekeMarshall/EcoVeg.jl)
 [![License](https://img.shields.io/github/license/ZekeMarshall/EcoVeg.jl)](LICENSE) 

diff --git a/docs/src/_intro.qmd b/docs/src/_intro.qmd
@@ -1,34 +1,22 @@
 # EcoVeg
 
 ```{julia}
-#| echo: false
+#| include: false
 using Pkg; Pkg.activate("docs")
 using EcoVeg
 ```
 
-`EcoVeg.jl` is a package containing functions for the analysis of vegetation plot sample data....
+Tools for vegetation science.
+
+## Background
 
 in vegetation science using the Julia programming language [@bezanson2017]
 
 Solves two language problem [@roesch2023]
 
 Aims to collate functionality found in JUICE, vegan, MAVIS into a single location with a user-friendly API and transparent methodologies.
 
-## Example Pluto Notebook 
-
-### Local Tour
-
-To run the tour locally, just clone this repo and start `Pluto.jl` as follows:
-
-```{.julia}
-] add Pluto
-using Pluto
-Pluto.run()
-```
-
-All notebooks are contained in `docs/pluto`.
-
-## Background
+Nomenclature follows @theurillat2021.
 
 
 ## Installation 

diff --git a/references.bib b/references.bib
@@ -156,6 +156,18 @@ @article{sperandii2024
   doi     = {10.1111/jvs.13224}
 }
 
+@article{theurillat2021,
+  title   = {International {{Code}} of {{Phytosociological Nomenclature}}. 4th Edition},
+  author  = {Theurillat, Jean-Paul and Willner, Wolfgang and {Fern{\'a}ndez-Gonz{\'a}lez}, Federico and B{\"u}ltmann, Helga and {\v C}arni, Andra{\v z} and Gigante, Daniela and Mucina, Ladislav and Weber, Heinrich},
+  year    = {2021},
+  journal = {Applied Vegetation Science},
+  volume  = {24},
+  number  = {1},
+  pages   = {e12491},
+  issn    = {1654-109X},
+  doi     = {10.1111/avsc.12491}
+}
+
 @article{tichy2002,
   title   = {{{JUICE}}, Software for Vegetation Classification},
   author  = {Tich{\'y}, Lubom{\'i}r},
@@ -167,4 +179,3 @@ @article{tichy2002
   issn    = {1654-1103},
   doi     = {10.1111/j.1654-1103.2002.tb02069.x}
 }
-