Skip to content

Commit d7751d0

Browse files
authored
Merge branch 'master' into add-javadoc-website
2 parents 7304278 + 8acfc1d commit d7751d0

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
11
# Spdx-Java-Rdf-Store
22

3-
This Java library implements an RDF store supported SPDX spec version 2.3 and earlier implementing the [SPDX Java Library Storage Interface](https://github.com/spdx/Spdx-Java-Library#storage-interface) using an underlying RDF store.
3+
This Java library implements an RDF store supported [SPDX spec version 2.3][spdx2.3] and earlier implementing the [SPDX Java Library Storage Interface][storage] using an underlying RDF store.
44

55
The API documentation is available at:
66
<https://spdx.github.io/spdx-java-rdf-store/>
7+
[spdx2.3]: https://spdx.github.io/spdx-spec/v2.3/
8+
[storage]: https://github.com/spdx/Spdx-Java-Library#storage-interface
79

8-
# Code quality badges
10+
## Code quality badges
911

10-
| [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=bugs)](https://sonarcloud.io/dashboard?id=spdx-rdf-store) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=security_rating)](https://sonarcloud.io/dashboard?id=spdx-rdf-store) | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=spdx-rdf-store) | [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=sqale_index)](https://sonarcloud.io/dashboard?id=spdx-rdf-store) |
12+
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=bugs)](https://sonarcloud.io/dashboard?id=spdx-rdf-store)
13+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=security_rating)](https://sonarcloud.io/dashboard?id=spdx-rdf-store)
14+
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=spdx-rdf-store)
15+
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=spdx-rdf-store&metric=sqale_index)](https://sonarcloud.io/dashboard?id=spdx-rdf-store)
1116

12-
# Using the Library
17+
## Using the Library
1318

1419
This library is intended to be used in conjunction with the [SPDX Java Library](https://github.com/spdx/Spdx-Java-Library).
1520

1621
Simply create a new instance of `RdfStore(documentNamespace)` and reference it as your storage. The documentNamespace is the namespace used for the store.
1722

18-
Note that this version of the RDF library only supports a single document namespace and DOES NOT support spec versions 3.0 and later.
23+
Note that this version of the RDF library only supports a single document namespace and DOES NOT support [SPDX spec versions 3.0][spdx3.0] and later.
1924

20-
# Serializing and Deserializing RDF Formats
25+
[spdx3.0]: https://spdx.github.io/spdx-spec/v3.0/
2126

22-
This library supports the `ISerializableModelStore` interface for serializing and deserializing RDF files and data stores.
27+
## Serializing and Deserializing RDF Formats
28+
29+
This library supports the [`ISerializableModelStore`][ISerializableModelStore] interface for serializing and deserializing RDF files and data stores.
2330

2431
The format is specified by calling the `setOutputFormat(OutputFormat outputFormat)` method.
2532

2633
OutputFormat must be one of RDF/XML-ABBREV (default), RDF/XML, N-TRIPLET, or TURTLE.
2734

2835
A convenience method `public String loadModelFromFile(String fileNameOrUrl, boolean overwrite)` can be used to load the model from a file or URL.
2936

30-
# Development Status
37+
[ISerializableModelStore]: https://spdx.github.io/spdx-java-core/org/spdx/storage/ISerializableModelStore.html
3138

32-
Less stable - it has just been updated to support the redesigned storage interfaces.
39+
## Development Status
3340

41+
Less stable - it has just been updated to support the redesigned storage interfaces.

0 commit comments

Comments
 (0)