Skip to content

Commit

Permalink
Explain basic usage
Browse files Browse the repository at this point in the history
  • Loading branch information
nichtich authored Oct 21, 2024
1 parent e400b52 commit 4feaa2f
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ cd coli-rich-web
npm ci
```

## Usage
To run the development server on port 3454:

```bash
Expand All @@ -39,9 +38,20 @@ To build the web app into the `dist/` directory:
npm run build
```

## Usage

There is an input form to give a PPN from K10plus catalogue.

- The PPN is looked up via **subjects API** to get a list of concepts, the record is indexed with (e.g. DDC Numbers, BK Notations...)
- Each subject is then queried to get mappings from via **JSKOS API** and corresponding enrichments
- Enrichments can be selected
- *Writing selected enrichment back to K10plus has not been implemented yet*

## Configuration
Currently not applicable, but will be relevant when a server component is added.



## To-Dos
- [ ] Code cleanup
- [ ] Split App.vue into multiple components
Expand Down

0 comments on commit 4feaa2f

Please sign in to comment.