Skip to content

Commit 216125b

Browse files
authored
Minor fixes to the README (#258)
1 parent e27e6e7 commit 216125b

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,26 +61,26 @@ jelly-cli rdf from-jelly input.jelly > output.nq
6161
```
6262

6363
By default, `jelly-cli` will translate files to NQuads.
64-
But you can also specify the output format with `--out-format`, for example:
64+
You can also specify the output format with `--out-format`, for example:
6565

6666
```shell
6767
jelly-cli rdf from-jelly input.jelly --out-format=ttl > output.ttl
6868
```
6969

70-
You can specify most well-known formats supported by Apache Jena, but also a custom Jelly-Text format.
71-
Jelly-Text is a human-readable translation of Jelly binary. It's not meant for machine consumption. It is useful for debugging and inspecting Jelly files.
70+
You can specify most well-known formats supported by Apache Jena, but also the custom `jelly-text` format.
71+
`jelly-text` is a human-readable translation of Jelly binary. It's not meant for machine consumption. It is useful for debugging and inspecting Jelly files.
7272

7373
### Transcode Jelly files
7474

75-
The `rdf transcode` command turns one or more input Jelly streams into a single output stream. It's extremely fast, using a dedicated transcoding algorithm. However, the numerical values for each of the options in the output stream must be greater than or equal to those in the input stream(s).
75+
The `rdf transcode` command turns one or more input Jelly streams into a single output stream. It's extremely fast, using a dedicated transcoding algorithm. This algorithm has a limitation: the lookup sizes of the output stream must be greater than or equal to the lookup sizes of the input streams.
7676

7777
```shell
7878
jelly-cli rdf transcode input.jelly > output.jelly
7979
```
8080

8181
### Inspect Jelly files
8282

83-
To inspect a Jelly file and get basic information describing its contents, such as stream options or number of triples in the file, run
83+
To inspect a Jelly file and get basic information describing its contents, such as stream options or number of triples in the file, run:
8484

8585
```shell
8686
jelly-cli rdf inspect input.jelly
@@ -96,7 +96,7 @@ In both cases, you will get the output as a valid YAML.
9696

9797
### Validate Jelly files
9898

99-
To validate a Jelly file, run
99+
To validate a Jelly file, run:
100100

101101
```shell
102102
jelly-cli rdf validate input.jelly
@@ -126,13 +126,13 @@ If for some reason the binaries wouldn't work for you, or you want to get better
126126
java -jar jelly-cli.jar --help
127127
```
128128

129-
For most use cases, we recommend using the binary distribution, because it has way faster startup times and doesn't require you to install Java.
129+
For simple day-to-day use cases, we recommend using the binary distribution, because it has way faster startup times and doesn't require you to install Java.
130130

131131
### Performance considerations
132132

133-
If you are bulk-converting large amounts of RDF data (>10M triples), you may want to use the JAR build instead of the pre-compiled binary. With the JAR, your JVM will perform just-in-time compilation, resulting in a better optimized code. The application will take longer to start, but the overall throughput will be better for large files.
133+
If you are bulk-converting large amounts of RDF data (>10M triples), you may want to use the JAR build instead of the pre-compiled binary. With the JAR, your JVM will perform just-in-time compilation, resulting in better optimized code. The application will take longer to start, but the overall throughput will be better for large files.
134134

135-
For maximum performance, we recommend using a recent JVM (e.g., GraalVM or OpenJDK). In some cases we saw up to 2x better throughput when running the JAR with GraalVM 24 in JIT mode, as compared to the pre-compiled binary.
135+
For maximum performance, we recommend using a recent JVM (e.g., OpenJDK 25). In some cases we saw up to 2x better throughput when running the JAR with GraalVM 24 in JIT mode, as compared to the pre-compiled binary.
136136

137137
## GitHub Action
138138

0 commit comments

Comments
 (0)