From 38cfeb03997e4ec3d2ac07f8ab3c5d3bf8ae78e5 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Tue, 24 Jan 2023 12:34:21 +0100 Subject: [PATCH] Fix: typos Fix: typos --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 39f0bbc7..da0c736a 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ We have tools to "explore" the Cardano blockchain, which are useful when you know what you're looking for. We argue that there's a different, complementary use-case which is to "observe" the blockchain and react to particular event patterns. -_Oura_ is a rust-native implementation of a pipeline that connects to the tip of a Cardano node through a combination of _Ouroboros_ mini-protocol (using either a unix socket or tcp bearer), filters the events that match a particular pattern and then submits a succint, self-contained payload to pluggable observers called "sinks". +_Oura_ is a rust-native implementation of a pipeline that connects to the tip of a Cardano node through a combination of _Ouroboros_ mini-protocol (using either a unix socket or tcp bearer), filters the events that match a particular pattern and then submits a succinct, self-contained payload to pluggable observers called "sinks". Check our [documentation](https://txpipe.github.io/oura) for detailed information on how to start working with _Oura_. ## Etymology -The name of the tool is inspired by the `tail` command available in unix-like systems which is used to display the tail end of a text file or piped data. Cardano's consensus procotol name, _Ouroboros_, is a reference to the ancient symbol depicting a serpent or dragon eating its own tail, which means "tail eating". "Oura" is the ancient greek word for "tail". +The name of the tool is inspired by the `tail` command available in unix-like systems which is used to display the tail end of a text file or piped data. Cardano's consensus protocol name, _Ouroboros_, is a reference to the ancient symbol depicting a serpent or dragon eating its own tail, which means "tail eating". "Oura" is the ancient greek word for "tail". ## Terminal Output Demo @@ -38,11 +38,11 @@ The data pipeline makes heavy use (maybe a bit too much) of multi-threading and ### CLI to Watch Live Transactions -You can run `oura watch ` to print TX data into the terminal from the tip of a local or remote node. It can be useful as a debugging tool for developers or if you're just curious to see whats going on in the network (for example, to see airdrops as they happen or oracles posting new information). +You can run `oura watch ` to print TX data into the terminal from the tip of a local or remote node. It can be useful as a debugging tool for developers or if you're just curious to see what's going on in the network (for example, to see airdrops as they happen or oracles posting new information). ### As a Bridge to Other Persistence Mechanisms -Similar to the well-known db-sync tool provided by IOHK, _Oura_ can be used as a daemon to follow a node and output the data into a different data storage techonology more suited for your final use-case. The main difference with db-sync is that _Oura_ was designed for easy integration with data-streaming pipelines instead of relational databases. +Similar to the well-known db-sync tool provided by IOHK, _Oura_ can be used as a daemon to follow a node and output the data into a different data storage technology more suited for your final use case. The main difference with db-sync is that _Oura_ was designed for easy integration with data-streaming pipelines instead of relational databases. Given its small memory / cpu footprint, _Oura_ can be deployed side-by-side with your Cardano node even in resource-constrained environments, such as Raspberry PIs. @@ -52,14 +52,14 @@ _Oura_ running in `daemon` mode can be configured to use custom filters to pinpo ### As a Library for Custom Scenarios -If the available out-of-the-box features don't satisfiy your particular use-case, _Oura_ can be used a library in your Rust project to setup tailor-made pipelines. Each component (sources, filters, sinks, etc) in _Oura_ aims at being self-contained and reusable. For example, custom filters and sinks can be built while reusing the existing sources. +If the available out-of-the-box features don't satisfy your particular use case, _Oura_ can be used a library in your Rust project to setup tailor-made pipelines. Each component (sources, filters, sinks, etc) in _Oura_ aims at being self-contained and reusable. For example, custom filters and sinks can be built while reusing the existing sources. ## How it Works -Oura is in its essence just a pipeline for proccessing events. Each stage of the pipeline fulfills a different roles: +Oura is in its essence just a pipeline for processing events. Each stage of the pipeline fulfills a different role: - Source Stages: are in charge of pulling data from the blockchain and mapping the raw blocks into smaller, more granular events. Each event is then sent through the output port of the stage for further processing. -- Filter Stages: receive individual events from the source stage and apply some sort of transformation to each one. The transformations applied will depend on the particular use-case, but they usually revolve around selecting relevant events and enriching them with extra information. +- Filter Stages: receive individual events from the source stage and apply some sort of transformation to each one. The transformations applied will depend on the particular use case, but they usually revolve around selecting relevant events and enriching them with extra information. - Sink Stages: receive the final events from the filter stage and submits the payload to some external system, database or service for further processing. ![diagram](assets/diagram.png) @@ -119,4 +119,4 @@ All contributions are welcome, but please read the [contributing guide](.github/ ## License -This project is licensed under the Apache-2.0 license. Please see the [LICENSE](LICENSE.md) file for more details. \ No newline at end of file +This project is licensed under the Apache-2.0 license. Please see the [LICENSE](LICENSE.md) file for more details.