run on specific paths (#280)

.github/workflows/documentation.yml

@@ -3,9 +3,14 @@ on:
   # Triggers the workflow on push but only for the main branch
   push:
     branches: [ main ]
+    paths:
+      - sed/**/*
+      - pyproject.toml
+      - tutorial/**
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+
   # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read

.github/workflows/release.yml

@@ -13,7 +13,9 @@ on:
       - main
     tags:
       - '*'
-
+    paths:
+      - sed/**/*
+      - pyproject.toml
 jobs:
   prerelease:
     if: github.ref == 'refs/heads/main'

README.md

@@ -1,3 +1,4 @@
+Backend to handle photoelectron resolved datastreams.
 [![Documentation Status](https://github.com/OpenCOMPES/sed/actions/workflows/documentation.yml/badge.svg)](https://opencompes.github.io/sed/)
 ![](https://github.com/OpenCOMPES/sed/actions/workflows/linting.yml/badge.svg?branch=main)
 ![](https://github.com/OpenCOMPES/sed/actions/workflows/testing_multiversion.yml/badge.svg?branch=main)
@@ -6,9 +7,6 @@
 [![](https://img.shields.io/pypi/v/sed-processor)](https://pypi.org/project/sed-processor)
 [![Coverage Status](https://coveralls.io/repos/github/OpenCOMPES/sed/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/OpenCOMPES/sed?branch=main)
 
-# Single Event Data Frame Processor
-
-Backend to handle photoelectron resolved datastreams.
 
 ## Installation