Skip to content

Commit 2bdd39b

Browse files
committed
README: How-to examples section
1 parent 65aa406 commit 2bdd39b

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,14 @@ The anonymization algorithm preserves the uniqueness of the anonymized strings
159159
in the document. This way, if the requirement UID identifiers are anonymized,
160160
they will still be unique strings in an anonymized document.
161161

162+
## How-to examples
163+
164+
The `tests/integration/examples` folder contains various examples of how the
165+
ReqIF library can be used. Some examples could be and will be made more
166+
advanced over time. The examples are stored in the integration tests folder, so
167+
that they don't regress over time. The feedback and other example requests are
168+
welcome.
169+
162170
## Implementation details
163171

164172
The core of the library is a **ReqIF first-stage parser** that only transforms

0 commit comments

Comments
 (0)