doc(readme): fix links and refer to example app #41
Conversation
README.md
Outdated
| @@ -75,14 +75,14 @@ npm install | |||
| npm test | |||
| ``` | |||
|
|
|||
| More extensive tests for this package are contained in the [tei-publisher-app](https://github.com/eeditiones/tei-publisher-app/tree/feature/open-api/test) repository. | |||
| More extensive tests for this package are contained in the [tei-publisher-app](https://github.com/eeditiones/tei-publisher-app/tree/master) repository. | |||
There was a problem hiding this comment.
Consider dropping the /tree/master bit, and let GitHub take folks to the default branch at: https://github.com/eeditiones/tei-publisher-app.
There was a problem hiding this comment.
Well, the link should go to the tests of tei-publisher-app so it definitely has to change to be meaningful. And for this to work I believe we have to link to a specific branch. But I might be wrong.
More importantly, the number of tests in the Roaster repository has grown significantly since this paragraph was added to the readme. We could it altogether, as it lowers confidence in the library that it is not tested well enough.
There was a problem hiding this comment.
I rephrased the paragraph slightly and the link now points to the location @joewiz suggested.
line-o
force-pushed
the
fix/links-in-readme
branch
from
7d1dfb2
to
694c06d
Compare
|
🎉 This PR is included in version 1.7.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
The OpenAPI feature is now in master of tei-publisher-app and it is also good to have more users look at the example application within the Roaster repository.