Skip to content

Commit

Permalink
Fix readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
kotauskas committed Aug 26, 2020
1 parent 70f76d1 commit 66b2e15
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Snec is a configuration system focused on compile-time guarantees and a way of n
While no built-in serialization support is provided, the architecture by itself is serialization-agnostic — using Serde and Snec for the same config table structure will work just fine.

Snec's architecture consists of those key components:
- **Config table** — the structure which contains the configuration data for the program. Config tables implement the [`Get`] trait to access its fields, which allows them to hand out [`Handle`]s to its fields. Handles ensure that the assigned receiver gets notified when the field changes, unless it's explicitly prompted to perform a silent modification.
- **Entry** — an uninhabited type (type with no possible values) implementing the [`Entry`] trait, representing an identifier for a field inside of a config table.
- **Receiver** — type implementing the [`Receiver`] trait which will receive notifications whenever a entry in a config table it's interested in is modified.
- **Config table** — the structure which contains the configuration data for the program. Config tables implement the `Get` trait to access its fields, which allows them to hand out `Handle`s to its fields. Handles ensure that the assigned receiver gets notified when the field changes, unless it's explicitly prompted to perform a silent modification.
- **Entry** — an uninhabited type (type with no possible values) implementing the `Entry` trait, representing an identifier for a field inside of a config table.
- **Receiver** — type implementing the `Receiver` trait which will receive notifications whenever a entry in a config table it's interested in is modified.

## Basic example
```rust
Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
//! While no built-in serialization support is provided, the architecture by itself is serialization-agnostic — using Serde and Snec for the same config table structure will work just fine.
//!
//! Snec's architecture consists of those key components:
//! - **Config table** — the structure which contains the configuration data for the program. Config tables implement the [`Get`] trait to access its fields, which allows them to hand out [`Handle`]s to its fields. Handles ensure that the assigned receiver gets notified when the field changes, unless it's explicitly prompted to perform a silent modification.
//! - **Entry** — an uninhabited type (type with no possible values) implementing the [`Entry`] trait, representing an identifier for a field inside of a config table.
//! - **Receiver** — type implementing the [`Receiver`] trait which will receive notifications whenever a entry in a config table it's interested in is modified.
//! - **Config table** — the structure which contains the configuration data for the program. Config tables implement the `Get` trait to access its fields, which allows them to hand out `Handle`s to its fields. Handles ensure that the assigned receiver gets notified when the field changes, unless it's explicitly prompted to perform a silent modification.
//! - **Entry** — an uninhabited type (type with no possible values) implementing the `Entry` trait, representing an identifier for a field inside of a config table.
//! - **Receiver** — type implementing the `Receiver` trait which will receive notifications whenever a entry in a config table it's interested in is modified.
//!
//! # Basic example
//! ```
Expand Down

0 comments on commit 66b2e15

Please sign in to comment.