Skip to content

Commit fddbce1

Browse files
committed
tweak readme
1 parent 310177f commit fddbce1

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,30 @@
77
[![Documentation Status](https://readthedocs.org/projects/fairdatapoint/badge/?version=latest)](https://fairdatapoint.readthedocs.io/en/latest/?badge=latest)
88
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19236251.svg)](https://doi.org/10.5281/zenodo.19236251)
99

10-
The [FAIR Data Point (FDP)] is an HTTP API for creating, storing, and serving FAIR metadata (**F**indable, **A**ccessible, **I**nteroperable, **R**eusable).
10+
The [FAIR Data Point (FDP)] provides an HTTP API for creating, storing, and serving FAIR (**F**indable, **A**ccessible, **I**nteroperable, **R**eusable) metadata in the form of [RDF].
1111
The metadata content is generated semi-automatically according to the [FAIR Data Point specification].
1212

1313
## Usage
1414

15-
More information about FDP, how to deploy it and use it can be found in the [FDP documentation].
15+
More information about the FDP, how to deploy it, and how to use it, can be found in the [FDP documentation].
1616

1717
### API Documentation
1818

19-
The FAIR Data Point API comes with embedded [OpenAPI] documentation based on SwaggerUI.
20-
Each FDP serves human friendly API documentation at the path `/swagger-ui.html`, for example, https://app.fairdatapoint.org/swagger-ui.html.
21-
In addition, machine readable API docs are available at the path `/v3/api-docs`, for example, https://app.fairdatapoint.org/v3/api-docs.
19+
The FAIR Data Point API also comes with embedded [OpenAPI] documentation based on SwaggerUI.
20+
Each FDP serves its own human friendly API documentation at the path `/swagger-ui.html`, for example, https://app.fairdatapoint.org/swagger-ui.html.
21+
In addition, machine readable API docs (JSON) are available at the path `/v3/api-docs`, for example, https://app.fairdatapoint.org/v3/api-docs.
2222

2323
## Development
2424

2525
### Technology Stack
2626

27+
The FDP runs on the following technology stack and is typically deployed as a Docker container.
28+
2729
- **Spring-boot**
2830
- **Java**
2931
- **Maven**
3032
- **MongoDB**
31-
- **Docker** (only required for building a Docker image)
33+
- **Docker** (only required for building a Docker image and running the container)
3234

3335
### Build & Run
3436

@@ -128,3 +130,4 @@ This project is licensed under the MIT License - see the [LICENSE] file for more
128130
[contribution guidelines]: CONTRIBUTING.md
129131
[code of conduct]: CODE_OF_CONDUCT.md
130132
[mongo docker image]: https://hub.docker.com/_/mongo/
133+
[RDF]: https://www.w3.org/TR/rdf11-primer/

0 commit comments

Comments
 (0)