chore: add web validator information to README#1399
Conversation
isabelle-dr
left a comment
isabelle-dr
left a comment
There was a problem hiding this comment.
Can we have the following order in the README.md:
- Introduction
- Using the web-based validator
- Using the Desktop app
- Using the command line
- Using Docker
Also, could you rename the video to validator_demo.mp4 and put it at the top below the introduction instead of the one we currently have showing the Desktop app?
README.md
Outdated
| The GTFS Web Validator can be accessed from [https://gtfs-validator.mobilitydata.org/](https://gtfs-validator.mobilitydata.org/). | ||
| The GTFS Web Validator accepts locally saved datasets and datasets available via the Web. Validation reports are available 30 days after creation and can be shared with their unique link. | ||
|
|
||
| The GTFS Web Validator contains two main components the GTFS Web Validator Client and the GTFS Validator Web Service. More information about these components can be found in [GTFS Web Validator Client](./web/client/README.md) and [GTFS Validator Web Service](./web/service/README.md) |
There was a problem hiding this comment.
We're missing a ":" after "two main components".
|
✅ Rule acceptance tests passed. |
2 participants
Summary:
This is part of the pre-release tasks. This PR adds the GTFS Web validator information to the project root's README file.
Expected behavior:
The GTFS Web Validator information is in the project root's README file and linking web client and service sub-packages README for more information.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle testto make sure you didn't break anything