From 8c9905fdcd2a7e47815be41ddd5250069ee73b7e Mon Sep 17 00:00:00 2001 From: LucaCappelletti94 Date: Tue, 13 Feb 2024 14:34:58 +0100 Subject: [PATCH] Added badges to Sirius repo --- .gitignore | 1 + bindings/sirius/Cargo.toml | 4 ++-- bindings/sirius/README.md | 12 +++++++----- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index 964aa596..14d3175b 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,4 @@ __pycache__/ # Ignore .idea folder .idea +.DS_Store \ No newline at end of file diff --git a/bindings/sirius/Cargo.toml b/bindings/sirius/Cargo.toml index 68114445..90b115ac 100644 --- a/bindings/sirius/Cargo.toml +++ b/bindings/sirius/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "sirius" +name = "sirius-bindings" version = "0.1.0" edition = "2021" license = "GPL-3.0" @@ -7,7 +7,7 @@ readme = "README.md" keywords = ["metabolomics", "SIRIUS", "LC-MS/MS"] authors = ["Earth Metabolome Initiative"] repository = "https://github.com/earth-metabolome-initiative/emi-monorepo/tree/main/bindings/sirius" -description = "Wrapper around SIRIUS CLI. " +description = "Rust bindings for the SIRIUS metabolomics tool" exclude = ["CONTRIB.md", ".DS_Store", "tests/.DS_Store", ".cargo_vcs_info.json"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/bindings/sirius/README.md b/bindings/sirius/README.md index 95202b93..c7a04a2c 100644 --- a/bindings/sirius/README.md +++ b/bindings/sirius/README.md @@ -1,4 +1,8 @@ # Sirius +[![Build status](https://github.com/earth-metabolome-initiative/sirius-rs/actions/workflows/sirius.yml/badge.svg)](https://github.com/earth-metabolome-initiative/sirius-rs/actions) +[![Crates.io](https://img.shields.io/crates/v/sirius-rs.svg)](https://crates.io/crates/sirius-rs) +[![Documentation](https://docs.rs/sirius-rs/badge.svg)](https://docs.rs/sirius-rs) + SIRIUS is a java-based software framework for the analysis of LC-MS/MS data of metabolites and other "small molecules of biological interest". SIRIUS integrates a collection of tools, including CSI:FingerID (with [COSMIC](https://bio.informatik.uni-jena.de/software/cosmic/), [ZODIAC](https://bio.informatik.uni-jena.de/software/zodiac/) and [CANOPUS](https://bio.informatik.uni-jena.de/software/canopus/). In particular, both the graphical user interface and the command line version of SIRIUS seamlessly integrate the CSI:FingerID and CANOPUS web services. For further reading we recommend you to refer to the official [Sirius website](https://bio.informatik.uni-jena.de/software/sirius/). @@ -207,12 +211,10 @@ Fuzzing is a technique for finding security vulnerabilities and bugs in software You can learn more about fuzzing [here](https://github.com/earth-metabolome-initiative/emi-monorepo/tree/sirius-bindings/bindings/sirius/fuzz). - -# Citing Sirius +## Citing Sirius +```bash Kai Dührkop, Markus Fleischauer, Marcus Ludwig, Alexander A. Aksenov, Alexey V. Melnik, Marvin Meusel, Pieter C. Dorrestein, Juho Rousu, and Sebastian Böcker, [SIRIUS 4: Turning tandem mass spectra into metabolite structure information.](https://doi.org/10.1038/s41592-019-0344-8) *Nature Methods* 16, 299–302, 2019. - - - +``` \ No newline at end of file