Skip to content

Commit c8e36e1

Browse files
committed
Much more README enhancements
1 parent 72d946a commit c8e36e1

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

components_move/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The [`Counter` example](./examples/counter/README.md) is a very simple example,
3737
`RoleMap` and `Capability` for role based access control. The accompanying
3838
[test file](./examples/counter/tests/counter_tests.move) demonstrates the Move user experience.
3939

40-
The TF product Audit Trails uses the `RoleMap` to manage access to the audit trail records and their operations, which
40+
The Trust Framework product *Audit Trails* uses the `RoleMap` to manage access to the audit trail records and their operations, which
4141
can be seen as a more complex example:
4242
* The `RoleMap` is integrated in the `audit_trail::main` module to manage access to the audit trail records and
4343
their operations. See [here](https://github.com/iotaledger/notarization/blob/main/audit-trail-move/sources/audit_trail.move#L208) for an example.

components_move/examples/counter/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ In general, to integrate the `RoleMap` into a shared object,
1111
we need to define a Permission enum similar to the [enum used for IOTA Audit Trails](https://github.com/iotaledger/notarization/blob/main/audit-trail-move/sources/permission.move#L10-L11).
1212

1313
The Permission enum for the shared `Counter` example is called `CounterPermission` and
14-
can be found in the [permission.move](./counter/permission.move) file.
14+
can be found in the [permission.move](./sources/permission.move) file.
1515

1616
## RoleMap Integration
1717

@@ -23,11 +23,11 @@ this example, requires the following steps. The target object needs to:
2323
* use the `RoleMap.is_capability_valid()` function to check whether a provided capability has the required permission
2424

2525
The implementation of the shared `Counter` example can be found in the
26-
[counter.move](./counter/counter.move) file.
26+
[counter.move](./sources/counter.move) file.
2727

2828
## User experience and testing the Integration
2929

30-
The accompanying [counter_tests.move](./examples/counter/tests/counter_tests.move) file demonstrates the
30+
The accompanying [counter_tests.move](./tests/counter_tests.move) file demonstrates the
3131
user experience of users interacting with the shared `Counter` object using the integrated
3232
`RoleMap` and `Capability` objects.
3333

0 commit comments

Comments
 (0)