Skip to content

Commit 07636a7

Browse files
committed
fix docs
1 parent 96a2435 commit 07636a7

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,17 @@ and then generates and saves the data as HDT. Implementation is based on the [HD
66
and the output HDT is intended to be consumed by one of [hdt crate](https://github.com/KonradHoeffner/hdt), [hdt-cpp](https://github.com/rdfhdt/hdt-cpp),
77
or [hdt-java](https://github.com/rdfhdt/hdt-java).
88

9-
## Using the rdf2hdt CLI
9+
## Installation
1010

11-
This library includes a CLI utility for gnerating HDT files from RDF input data. The binary can be built using `cargo build`.
11+
Install `rdf2hdt` with `cargo`:
12+
13+
```bash
14+
cargo install rdf2hdt
15+
```
16+
17+
## Usage
18+
19+
The `rdf2hdt` CLI tool is used for generating HDT files from RDF input data.
1220

1321
```bash
1422
$ rdf2hdt convert --help
@@ -32,13 +40,6 @@ Options:
3240
-v, --verbose...
3341
Increase logging verbosity
3442

35-
-b, --block-size <BLOCK_SIZE>
36-
Block size used during term compression
37-
38-
Every Nth term will be stored fully while others will only contain everything besides the longest common prefix of the last Nth term
39-
40-
[default: 16]
41-
4243
-q, --quiet...
4344
Decrease logging verbosity
4445

@@ -51,12 +52,11 @@ Options:
5152
HDT files can be generated directly in Rust.
5253

5354
```rust
54-
use rdf2hdt::hdt::{buld_hdt, Options};
55+
use rdf2hdt::hdt::buld_hdt;
5556

5657
let result = build_hdt(
5758
vec!["tests/resources/apple.ttl".to_string()],
5859
"output.hdt",
59-
Options::default(),
6060
)?;
6161
```
6262

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
// Licensed under the BSD 3-Clause License (see LICENSE file in the project root).
33

44
pub mod builder;
5-
pub mod rdf_reader;
5+
pub(crate) mod rdf_reader;

src/rdf_reader.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use std::{
1414
path::Path,
1515
};
1616

17-
pub fn convert_to_nt(
17+
pub(crate) fn convert_to_nt(
1818
file_paths: Vec<String>,
1919
output_file: std::fs::File,
2020
) -> Result<(), Box<dyn Error>> {

0 commit comments

Comments
 (0)