Skip to content

Commit a05eaa7

Browse files
authored
Minor fixes in README (#183)
1 parent d896a64 commit a05eaa7

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ If you are using Linux (x86_64, ARM64), macOS (ARM64), or WSL on Windows, the re
1010
To do so, run:
1111

1212
```shell
13-
$ . <(curl -sSfL https://raw.githubusercontent.com/Jelly-RDF/cli/main/install.sh)
14-
$ jelly-cli
13+
. <(curl -sSfL https://raw.githubusercontent.com/Jelly-RDF/cli/main/install.sh)
14+
jelly-cli
1515
```
1616

1717

@@ -20,8 +20,8 @@ For Windows (x86_64), the recommended way run `jelly-cli` is to use a pre-built
2020
You can then run it like so:
2121

2222
```shell
23-
$ chmod +x jelly-cli
24-
$ ./jelly-cli
23+
chmod +x jelly-cli
24+
./jelly-cli
2525
```
2626

2727
## Usage
@@ -31,22 +31,22 @@ $ ./jelly-cli
3131
To convert an RDF file (e.g., Turtle) to Jelly, simply run:
3232

3333
```shell
34-
$ jelly-cli rdf to-jelly input.ttl > output.jelly
34+
jelly-cli rdf to-jelly input.ttl > output.jelly
3535
```
3636

3737
### Convert Jelly to RDF
3838

3939
To convert from Jelly to RDF run:
4040

4141
```shell
42-
$ jelly-cli rdf from-jelly input.jelly > output.nq
42+
jelly-cli rdf from-jelly input.jelly > output.nq
4343
```
4444

4545
By default, `jelly-cli` will translate files to NQuads.
4646
But you can also specify the output format with `--out-format`, for example:
4747

4848
```shell
49-
$ jelly-cli rdf from-jelly input.jelly --out-format=ttl > output.ttl
49+
jelly-cli rdf from-jelly input.jelly --out-format=ttl > output.ttl
5050
```
5151

5252
You can specify most well-known formats supported by Apache Jena, but also a custom Jelly-Text format.
@@ -57,21 +57,21 @@ Jelly-Text is a human-readable translation of Jelly binary. It's not meant for m
5757
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).
5858

5959
```shell
60-
$ jelly-cli rdf transcode input.jelly > output.jelly
60+
jelly-cli rdf transcode input.jelly > output.jelly
6161
```
6262

6363
### Inspect Jelly files
6464

6565
To inspect a Jelly file and get basic information describing its contents, such as stream options or number of triples in the file, run
6666

6767
```shell
68-
$ jelly-cli rdf inspect input.jelly
68+
jelly-cli rdf inspect input.jelly
6969
```
7070

7171
You can also compute the statistics separately for each stream frame with the `--per-frame` option:
7272

7373
```shell
74-
$ jelly-cli rdf inspect input.jelly --per-frame
74+
jelly-cli rdf inspect input.jelly --per-frame
7575
```
7676

7777
In both cases, you will get the output as a valid YAML.
@@ -81,7 +81,7 @@ In both cases, you will get the output as a valid YAML.
8181
To validate a Jelly file, run
8282

8383
```shell
84-
$ jelly-cli rdf validate input.jelly
84+
jelly-cli rdf validate input.jelly
8585
```
8686

8787
You can also check whether the Jelly file has been encoded using specific stream options or is equivalent to another RDF file, with the use of additional options to this command.
@@ -91,11 +91,11 @@ You can also check whether the Jelly file has been encoded using specific stream
9191
Use the `--help` option to learn more about all the available settings:
9292

9393
```shell
94-
$ jelly-cli rdf to-jelly --help
95-
$ jelly-cli rdf from-jelly --help
96-
$ jelly-cli rdf transcode --help
97-
$ jelly-cli rdf inspect --help
98-
$ jelly-cli rdf validate --help
94+
jelly-cli rdf to-jelly --help
95+
jelly-cli rdf from-jelly --help
96+
jelly-cli rdf transcode --help
97+
jelly-cli rdf inspect --help
98+
jelly-cli rdf validate --help
9999
```
100100

101101
And use the `--debug` option to get more information about any exceptions you encounter.
@@ -120,7 +120,7 @@ For maximum performance, we recommend using a recent JVM (e.g., GraalVM or OpenJ
120120

121121
If you're using `jelly-cli` in your GitHub Action CI/CD workflows, consider using the `jelly-rdf/setup-cli` action ([Marketplace link](https://github.com/marketplace/actions/setup-jelly-cli)). The action will automatically download and install the appropriate binary. Simply run the action before `jelly-cli` usage:
122122

123-
```
123+
```yaml
124124
steps:
125125
- uses: Jelly-RDF/setup-cli@v1
126126

0 commit comments

Comments
 (0)