diff --git a/README.md b/README.md index 17df9bb..9b9c8fe 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ License label

-tripsu (/tɹˈɪpsˈuː/, **trip**le **pseu**donymizer) is a tool to protect +`tripsu` (/tɹˈɪpsˈuː/, **trip**le **pseu**donymizer) is a tool to protect sensitive values in [RDF triples](https://en.wikipedia.org/wiki/Semantic_triple) through [pseudonymization](https://en.wikipedia.org/wiki/Pseudonymization). The goal is to offer a fast, secure and memory-efficient pseudonymization solution @@ -39,33 +39,41 @@ The tool works in two steps: -- [tripsu](#tripsu) - - [Installation & Usage](#installation-usage) - - [Usage](#usage) - - [Use Case](#use-case) - - [Example](#example) - - [1. Pseudonymize the URI of nodes with `rdf:type`](#1-pseudonymize-the-uri-of-nodes-with-rdftype) - - [2. Pseudonymize values for specific subject-predicate combinations](#2-pseudonymize-values-for-specific-subject-predicate-combinations) - - [3. Pseudonymize any value for a given predicate](#3-pseudonymize-any-value-for-a-given-predicate) - - [Development](#development) - [Setup](#setup) - - [Development Shell with `nix`](#development-shell-with-nix) - - [Formatting](#formatting) - [Building](#building) - [Testing](#testing) - +- [Installation](#installation) + - [Container](#container) + - [Source Build](#source-build) +- [Usage](#usage) +- [Development](#development) + ## Installation -The package must be compiled from source using +### Container + +Run the container image directly with `docker` or `podman`: + +```shell +docker run -it ghcr.io/sdsc-ordes/tripsu:0.0.1 --help +``` + +### Source Build + +The package can be compiled from source using [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html): ```shell git clone https://github.com/sdsc-ordes/tripsu cd tripsu cargo build --release -# executable binary located in ./target/release/tripsu + +./target/release/tripsu --help ``` +> [!TIP] +> Check the [development section](#development) for other setups (Nix etc.). + ## Usage The general command-line interface outlines the two main steps of the tool, @@ -110,10 +118,12 @@ tripsu pseudo --index index.nt --config rules.yaml input.nt > output.nt In both subcommands, the input defaults to stdin and the output to stdout, allowing to pipe both up- and downstream `tripsu` (see next section). -For more information about use-cases and configuration, see the [tutorial](docs/tutorial.md). +For more information about use-cases and configuration, see the +[tutorial](docs/tutorial.md). ## Development Read first the [Contribution Guidelines](/CONTRIBUTING.md). -For technical documentation on setup and development, see the [Development Guide](docs/development_guide.md) +For technical documentation on setup and development, see the +[Development Guide](docs/development-guide.md) diff --git a/docs/assets/logo.png b/docs/assets/logo.png index 9b601a3..0dd9fbc 100644 --- a/docs/assets/logo.png +++ b/docs/assets/logo.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2cd84f86ed4c15b01f4121b9c39520bd2431e6149259883e35e2f1aa4c02116f -size 251095 +oid sha256:4c345438648f9cc7433694480402601f6356fb3b84ac26bdb831ca9951199543 +size 280179 diff --git a/docs/development_guide.md b/docs/development-guide.md similarity index 100% rename from docs/development_guide.md rename to docs/development-guide.md