Skip to content

Commit 66e6a46

Browse files
committed
[feat] update README.md Rust Definition Package
1 parent 9290c1b commit 66e6a46

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,10 @@ for (const feature in features) {
9090
```
9191

9292
## Rust Definition Package
93+
This package is a Rust crate designed to read and parse Code0 definition files (JSON) from a directory structure. It loads all features, including their data types, flow types, and runtime functions, providing them as idiomatic Rust structs.
9394

95+
### Package Resources
96+
Create: [code0-definition-reader](https://crates.io/crates/code0-definition-reader) on crates.io
9497
### Install Package
9598
```bash
9699
cargo add code0-definition-reader
@@ -99,14 +102,23 @@ cargo add code0-definition-reader
99102
### Usage
100103

101104
```rs
102-
use code0_definition_reader::Definition;
105+
use code0_definition_reader::Reader;
103106

104-
let features = Definition::new("./path/to/definitions");
107+
let reader = Reader::configure(
108+
String::new(), // Path required for configure
109+
false, // should_break
110+
Vec::new(), // accepted_features
111+
None // accepted_versions
112+
);
113+
114+
let features = reader.read_features("./path/to/definitions");
105115

106116
for feature in features {
107-
let name = feature.name(); //name of the feature (e.g. rest)
108-
let data_types = feature.data_types(); //dataTypes of this feature
109-
let flow_types = feature.flow_types(); //flowTypes of this feature
110-
let functions = feature.runtime_functions(); //runtimeFunctions of this feature
117+
let name = &feature.name; // name of the feature (e.g., http)
118+
let data_types = &feature.data_types; // dataTypes of this feature
119+
let flow_types = &feature.flow_types; // flowTypes of this feature
120+
let functions = &feature.functions; // runtimeFunctions of this feature
121+
122+
println!("Loaded feature: {}", name);
111123
}
112124
```

0 commit comments

Comments
 (0)