polish up

.github/workflows/lint-test-build.yml

@@ -2,7 +2,7 @@ name: lint-test-build-push
 on:
   push:
     paths-ignore:
-      - '*.md'
+      - '**/*.md'
       - '.github/**'
       - 'ci/**'
 

README.md

@@ -1,6 +1,31 @@
 # scyllaridae
 
-Any command that takes some input and prints an output can use scyllaridae.
+Any command that takes a file as input and prints a result as output can use scyllaridae.
+
+Both `GET` and `POST` requests are supported.
+
+`GET` supports Islandora's alpaca/event spec, which sends a URL of a file as an HTTP header `Apix-Ldp-Resource` and prints the result. e.g. to create a VTT file from an audio file:
+
+```
+curl -H "Apix-Ldp-Resource: https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav" \
+  http://localhost:8080
+WEBVTT
+
+00:00:00.000 --> 00:00:11.000
+ And so my fellow Americans, ask not what your country can do for you, ask what you can do for your country.
+```
+
+`POST` supports directly uploading a file to the service
+
+```
+curl -H "Content-Type: audio/x-wav" \
+  --data-binary "@output.wav" \
+  http://localhost:8080/
+WEBVTT
+
+00:00:00.000 --> 00:00:02.960
+ Lehigh University Library Technology.
+```
 
 ## Adding a new microservice
 

internal/config/server.go

@@ -285,7 +285,7 @@ func GetPassedArgs(args string) ([]string, error) {
 
 func (c *ServerConfig) GetFileStream(r *http.Request, message api.Payload, auth string) (io.ReadCloser, int, error) {
 	if r.Method == http.MethodPost {
-		return r.Body, 200, nil
+		return r.Body, http.StatusOK, nil
 	}
 	req, err := http.NewRequest("GET", message.Attachment.Content.SourceURI, nil)
 	if err != nil {
@@ -305,5 +305,5 @@ func (c *ServerConfig) GetFileStream(r *http.Request, message api.Payload, auth
 		return nil, http.StatusFailedDependency, fmt.Errorf("failed dependency")
 	}
 
-	return sourceResp.Body, 200, nil
+	return sourceResp.Body, http.StatusOK, nil
 }