Skip to content

Commit a830dab

Browse files
committed
update readme
1 parent 922c2b4 commit a830dab

1 file changed

Lines changed: 3 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Description
44
This project is a TypeScript/JavaScript application that processes RDF data to create a graph representation. It uses React for the frontend and Chakra UI for styling.
55

6-
We strongly suggest users to use `turtle for`mat for RDF data and `schema.org` vocabulary for the properties. The application is designed to work with the `schema.org` vocabulary, since we developed it for a specific use case. However, it can be easily modified to work with other vocabularies.
6+
We strongly suggest users to use `turtle` format for RDF data and `schema.org` vocabulary for the properties. The application is designed to work with the `schema.org` vocabulary, since we developed it for a specific use case. However, it can be easily modified to work with other vocabularies.
77

88
## Features
99
- Parses RDF data and filters relevant properties.
@@ -36,7 +36,8 @@ npm run build
3636
```
3737

3838
## Configuration
39-
Configuration file has the necessary information to show nodes and links in the graph. Since a 3D graph on the browser consumes a lot of resources, it is important to filter the data to show only the necessary information. Properties that are not in the yaml file will be ignored.
39+
Configuration file has the necessary information to show nodes and links in the graph. Since a 3D graph on the browser consumes a lot of resources, it is important to filter the data to show only the necessary information. Properties that are not in the yaml file will be ignored. You can check [example config file](examples/config.yml) for more information.
40+
You can also check example RDF files in the examples folder to see how the data should be formatted.
4041

4142
The configuration file is a YAML file that has the following properties:
4243
```yaml
@@ -58,7 +59,6 @@ groups:
5859
color: '#FF0000'
5960
```
6061
61-
- `relevantProperties`: List of properties that will be used to filter the data.
6262
- `relationProperties`: List of properties that will be used to create links between nodes.
6363
- `labelProperties`: List of properties that will be used to create labels for nodes.
6464
- `groups`: List of groups that will be created based on the properties. Each group has the following properties:
@@ -73,9 +73,6 @@ If you want to cite this project in your scientific work,
7373
please use the [citation file](https://citation-file-format.github.io/)
7474
in the [repository](https://github.com/Materials-Data-Science-and-Informatics/rdf-graph-visualization/blob/main/CITATION.cff).
7575

76-
<!-- --8<-- [end:citation] -->
77-
<!-- --8<-- [start:acknowledgements] -->
78-
7976
## Acknowledgements
8077

8178
We kindly thank all authors and contributors.

0 commit comments

Comments
 (0)