Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcolarosa committed Apr 17, 2024
1 parent 0e4e08d commit 602eeb7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions src/docs/component/advanced-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ If you connect to the component via a reference, you will get access to an objec
properties:

- cm: the internal CrateManager instance that the component uses to manipulate the data;
- pm: the internal ProfileManager instance; makes handling profiles/schema.org classes easy;
- refresh: a method to tell the current entity to refresh its display;
- setCurrentEntity({ id }): a method to set the enity to display;
- setTab(tabName): a method to display the selected tab.
Expand Down
8 changes: 4 additions & 4 deletions src/docs/component/crate-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ The component has a built in RO-Crate manager that knows how to work with and ma
based on actions within the component. As this is now available to users of the component it's worth
noting that it can be used in your application without using the component.

[API documentation.](https://describo.github.io/crate-builder-component)
## API Documentation

- [CrateManager](https://describo.github.io/crate-builder-component/CrateManager.html)
- [ProfileManager](https://describo.github.io/crate-builder-component/ProfileManager.html)

## Initialisation and usage

Expand Down Expand Up @@ -49,9 +52,6 @@ for (let e of es) {
let e = cm.addEntity({ '@id': ..., '@type': ..., ... })
```

And much more. See the
[API documentation for more information and examples](https://describo.github.io/crate-builder-component)

## How does it compare to ro-crate-js

There is an NPM package for manipulating RO-Crates called `ro-crate-js`. `CrateManager` does the
Expand Down

0 comments on commit 602eeb7

Please sign in to comment.