Update README with clearer instructions for running the server #94
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
While trying to get the readium-go-toolkit server running locally, I encountered two main pain points:
The
publication-path
specified in the example config file (./publications
) doesn't match the actual location of the test publications in the repo (./test
). This caused some confusion and lost time trying to troubleshoot why no publications were being served.The current README lacks clear information about what endpoints are available and how to interact with them to retrieve publication data. As a new user, I had to dig through the code to understand the API surface.
Solution
This PR updates the README to address these issues and smooth out the onboarding process for new developers:
publication-path
discrepancy and providing instructions on how to resolve it/list.json
,/manifest.json
, and asset endpoints to retrieve publication datapublication-path
to./test
when using the provided test publicationsBenefits