Skip to content

Commit

Permalink
docs: move processors to main readme [no ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
jenspots committed May 24, 2024
1 parent 6a86f0a commit 73f1f82
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 0 additions & 17 deletions src/main/kotlin/std/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

0 comments on commit 73f1f82

Please sign in to comment.