Update README with clearer instructions for running the server

[rubywwwilde]

trafficstars

Problem

While trying to get the readium-go-toolkit server running locally, I encountered two main pain points:

1. 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.

2. 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:

1. Adds a note in the "Running the server" section calling out the publication-path discrepancy and providing instructions on how to resolve it
2. Introduces a new "Accessing a publication" section with step-by-step examples of how to hit the /list.json, /manifest.json, and asset endpoints to retrieve publication data
3. Includes a comment in the example config file about updating publication-path to ./test when using the provided test publications

Benefits

• Reduces confusion and frustration when first trying to run the server locally
• Provides a clear "happy path" for getting up and running with the API and exploring the functionality
• Improves the overall developer experience and onboarding process for the project

[chocolatkey]

Hi @doomuch , sorry about the delay in response, I was on a trip and was not available here. First of all, thanks very much for interest in helping with the docs, that's not my strong point. However, I was planning to remove the cmd/server program in a future commit, in favor of the rwp program's serve function, which is effectively replacing & improving it, save for a few things that I don't think should be decided by this implementation (e.g. Sentry as the error reporting service).

I think your documentation could be adapted to the rwp serve command as well. Let me know what you think, I can also try and work on that.

[chocolatkey]

@flavour-of-qualia Any update on my previous reply?

[rubywwwilde]

Oh, sorry, I did not see your message! I am bad with github notifications since many of them come from a Linear bot. I have not used readium for a long time and I forgot everything about how it works. If I decide to go back to it, I'll be glad to help with docs.

[chocolatkey]

OK thanks. Then I'll close this PR for now, and we can re-open it if the time comes