chore: add citation and update docs

.releaserc.json

@@ -14,7 +14,12 @@
     [
       "@semantic-release/git",
       {
-        "assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
+        "assets": [
+          "package.json",
+          "package-lock.json",
+          "CHANGELOG.md",
+          "CITATION.cff"
+        ],
         "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
       }
     ]

CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+message: 'If you use ExfilMS in your work, please cite it using the following.'
+authors:
+  - family-names: 'Nambiar'
+    given-names: 'Vimalnath'
+    orcid: 'https://orcid.org/0000-0001-5384-6788'
+title: 'ExfilMS'
+version: 1.2.2
+abstract: 'A cross-platform, command line interface (CLI) tool to extract mass spectrometry (MS) data from mzML formatted files, with filtering capabilities.'
+keywords:
+  - 'mass spectrometry'
+  - 'data extraction'
+  - 'spectrum filtering'
+  - 'data standardisation'
+  - 'command line tool'
+  - 'open source'
+license: 'MIT'
+doi:
+date-released: '2024-04-16'
+url: 'https://github.com/vmalnathnambiar/exfilms'

README.md

@@ -8,7 +8,7 @@
 
 ## Introduction
 
-ExfilMS is a cross-platform, command line interface (CLI) tool to extract mass spectrometry (MS) data from mzML formatted files, with spectrum filtering capabilities.
+ExfilMS is a cross-platform, command line interface (CLI) tool to extract mass spectrometry (MS) data from mzML formatted files, with filtering capabilities.
 
 <br>
 

docs/how-to-exfilms-the-complete-guide.md

@@ -18,7 +18,7 @@
 
 ## Introduction
 
-ExfilMS is a cross-platform, command line interface (CLI) tool that allows you to easily extract mass spectrometry (MS) data from mzML formatted files, with spectrum filtering capabilities. This guide will help you understand how to use ExfilMS to its full potential.
+ExfilMS is a cross-platform, command line interface (CLI) tool that allows you to easily extract mass spectrometry (MS) data from mzML formatted files, with filtering capabilities. This guide will help you understand how to use ExfilMS to its full potential.
 
 > [!NOTE]\
 > If you are reading this guide, it is assumed that you have ExfilMS already installed and is available on your device. If it is not installed, please refer to the installation guide [here](../README.md#installation).

package.json

@@ -1,11 +1,32 @@
 {
   "name": "exfilms",
   "version": "1.2.2",
-  "description": "A cross-platform, command line interface (CLI) tool to extract mass spectrometry (MS) data from mzML formatted files, with spectrum filtering capabilities.",
+  "description": "A cross-platform, command line interface (CLI) tool to extract mass spectrometry (MS) data from mzML formatted files, with filtering capabilities.",
+  "keywords": [
+    "mass spectrometry",
+    "data extraction",
+    "spectrum filtering",
+    "data standardisation",
+    "command line tool",
+    "open source"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vmalnathnambiar/exfilms.git"
+  },
+  "homepage": "https://github.com/vmalnathnambiar/exfilms#readme",
+  "bugs": {
+    "url": "https://github.com/vmalnathnambiar/exfilms/issues"
+  },
+  "author": {
+    "name": "Vimalnath Nambiar",
+    "orcid": "https://orcid.org/0000-0001-5384-6788"
+  },
+  "type": "module",
   "bin": {
     "exfilms": "./src/exfilms.js"
   },
-  "type": "module",
   "scripts": {
     "eslint": "eslint src",
     "eslint-fix": "npm run eslint -- --fix",
@@ -17,24 +38,6 @@
     "semantic-release": "semantic-release",
     "commit": "git cz"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/vmalnathnambiar/exfilms.git"
-  },
-  "keywords": [
-    "mass spectrometry",
-    "data extraction",
-    "spectrum filtering",
-    "data standardisation",
-    "command line tool",
-    "open source"
-  ],
-  "author": "Vimalnath Nambiar",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/vmalnathnambiar/exfilms/issues"
-  },
-  "homepage": "https://github.com/vmalnathnambiar/exfilms#readme",
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",

src/exfilms.js

@@ -43,7 +43,7 @@ figlet('ExfilMS', async (err, data) => {
     );
     console.log(
       `${chalk.bold.yellowBright(data)}\n${chalk.grey(
-        `Version ${pkg.version} ${pkg.author}\n${pkg.description}\n`,
+        `Version ${pkg.version}\n${pkg.description}\n`,
       )}`,
     );