From 73f1f82005d06a3073a2df2661dce66ff9de1ec3 Mon Sep 17 00:00:00 2001 From: Jens Pots Date: Fri, 24 May 2024 19:53:25 +0200 Subject: [PATCH] docs: move processors to main readme [no ci] --- README.md | 17 +++++++++++++++++ src/main/kotlin/std/README.md | 17 ----------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 35fb88e..c21b658 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,23 @@ A proof-of-concept implementation of a Kotlin-based JVM runner. Currently, this This runner includes a set of standard processors that can be used directly by the end user without the need for additional dependencies. These processors also serve as a reference for processor developers. The implementation can be found [here](src/main/kotlin/std). +##### Network Utilities + +These processors interact with the network. + +| Processor | Description | +|-------------------------------------------------------|-----------------------------------| +| [`jvm:HttpFetch`](./src/main/kotlin/std/HttpFetch.kt) | Reads data from an HTTP endpoint. | + +##### File Utilities + +These processors interact with the local file system. + +| Processor | Description | +|---------------------------------|------------------------------------------------------------------------| +| [`jvm:FileReader`](./src/main/kotlin/std/FileReader.kt) | Reads a file with a given `path` from the local file system. | +| [`jvm:FileWriter`](./src/main/kotlin/std/FileWriter.kt) | Overwrites/appends a file with a given `path` using the incoming data. | + #### Datatypes At the time of writing, the JVM Runner supports a limit set of datatypes and classes. You may use either wrapper classes or the primitive types directly. diff --git a/src/main/kotlin/std/README.md b/src/main/kotlin/std/README.md index ed54ca0..eecd8fc 100644 --- a/src/main/kotlin/std/README.md +++ b/src/main/kotlin/std/README.md @@ -3,20 +3,3 @@ This directory contains implementations of processors which can be used directly by the end user, without the need for additional dependencies. These also exist as a reference to processor developers. Their RDF definitions can be found [here](./../../resources/std). These are included in the default ontology. - -## Network Utilities - -These processors interact with the network. - -| Processor | Description | -|-------------------------------|-----------------------------------| -| [jvm:HttpFetch](HttpFetch.kt) | Reads data from an HTTP endpoint. | - -## File Utilities - -These processors interact with the local file system. - -| Processor | Description | -|---------------------------------|------------------------------------------------------------------------| -| [jvm:FileReader](FileReader.kt) | Reads a file with a given `path` from the local file system. | -| [jvm:FileWriter](FileWriter.kt) | Overwrites/appends a file with a given `path` using the incoming data. |