Skip to content

Commit 023a705

Browse files
committed
Improve the README.
1 parent 63b58b2 commit 023a705

1 file changed

Lines changed: 32 additions & 3 deletions

File tree

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Package](https://img.shields.io/crates/v/asimov-sdk)](https://crates.io/crates/asimov-sdk)
66
[![Documentation](https://img.shields.io/docsrs/asimov-sdk?label=docs.rs)](https://docs.rs/asimov-sdk)
77

8-
**[ASIMOV] is a polyglot development platform for trustworthy, neurosymbolic AI.**
8+
**[ASIMOV] is a polyglot development platform for [trustworthy, neurosymbolic AI].**
99

1010
<br/>
1111

@@ -22,6 +22,11 @@
2222

2323
## ✨ Features
2424

25+
- Defines [flow-based] [program patterns] for refining data into knowledge.
26+
- Implements a [module system] supporting an ecosystem of [ASIMOV modules].
27+
- Enables dataflow systems through reusable components called blocks.
28+
- Built on the dataflow primitives provided by the [Async-Flow] crate.
29+
- Compatible with the inventory of dataflow blocks provided by [Flows.rs].
2530
- Supports opting out of any feature using comprehensive feature flags.
2631
- Adheres to the Rust API Guidelines in its [naming conventions].
2732
- Cuts red tape: 100% free and unencumbered public domain software.
@@ -35,7 +40,7 @@
3540
### Installation via Cargo
3641

3742
```bash
38-
cargo add asimov-sdk
43+
cargo add asimov-sdk --rename asimov
3944
```
4045

4146
### Installation in `Cargo.toml` (with all features enabled)
@@ -57,7 +62,7 @@ asimov = { package = "asimov-sdk", "version" = "25", default-features = false, f
5762
### Importing the SDK
5863

5964
```rust
60-
use asimov::*;
65+
use asimov::{config, env, flow, id, kb, patterns, registry, runner, snapshot};
6166
```
6267

6368
## 📚 Reference
@@ -111,6 +116,22 @@ use asimov::*;
111116
git clone https://github.com/asimov-platform/asimov.rs.git
112117
```
113118

119+
### Glossary
120+
121+
- **System**: A collection of blocks that are connected together.
122+
Systems are the top-level entities in dataflow programs.
123+
124+
- **Block**: An encapsulated system component that processes messages.
125+
Blocks are the autonomous units of computation in a system.
126+
127+
- **Port**: A named connection point on a block that sends or receives
128+
messages. Ports are the only interfaces through which blocks communicate
129+
with each other.
130+
131+
- **Message**: A unit of data that flows between blocks in a system, from port
132+
to port. Any Rust type that implements the `Send + Sync + 'static` traits can
133+
be used as a message.
134+
114135
---
115136

116137
[![Share on X](https://img.shields.io/badge/share%20on-x-03A9F4?logo=x)](https://x.com/intent/post?url=https://github.com/asimov-platform/asimov.rs&text=ASIMOV%20Software%20Development%20Kit%20%28SDK%29%20for%20Rust)
@@ -120,3 +141,11 @@ git clone https://github.com/asimov-platform/asimov.rs.git
120141
[![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/asimov-platform/asimov.rs)
121142

122143
[ASIMOV]: https://asimov.sh
144+
[ASIMOV modules]: https://github.com/asimov-modules
145+
[Async-Flow]: https://github.com/artob/async-flow
146+
[Flows.rs]: https://github.com/artob/flows.rs
147+
[flow-based]: https://github.com/artob/awesome-fbp
148+
[naming conventions]: https://rust-lang.github.io/api-guidelines/naming.html
149+
[module system]: https://asimov-specs.github.io/
150+
[program patterns]: https://asimov-specs.github.io/program-patterns/
151+
[trustworthy, neurosymbolic AI]: https://asimov.blog/introducing-asimov/

0 commit comments

Comments
 (0)