diff --git a/gymboard-api/README.md b/gymboard-api/README.md index 74e6b1a..827ec32 100644 --- a/gymboard-api/README.md +++ b/gymboard-api/README.md @@ -1,3 +1,7 @@ # Gymboard API -An HTTP/REST API powered by Java and Spring Boot. This API serves as the main entrypoint +An HTTP/REST API powered by Java and Spring Boot. This API serves as the main entrypoint for all data processing, and is generally the first point-of-contact for the web app or other services that consume Gymboard data. + +## Development + +To ease development, `nl.andrewlalis.gymboard_api.model.SampleDataLoader` will run on startup and populate the database with some sample entities. You can regenerate this data by manually deleting the database, and deleting the `.sample_data` marker file that's generated in the project directory.