Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update README #1222

Merged
merged 5 commits into from
Aug 1, 2022
Merged

Docs: Update README #1222

merged 5 commits into from
Aug 1, 2022

Conversation

isabelle-dr
Copy link
Contributor

@isabelle-dr isabelle-dr commented Aug 1, 2022

Added video demo, improved the top section of the document, added links to rule mapping docs

Expected behavior:

Please make sure these boxes are checked before submitting your pull request - thanks!

  • [ ] Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)

Screen Shot 2022-08-01 at 7 20 37 AM

Added direct link to usage parts, added links to rule mapping docs, improved title
@isabelle-dr isabelle-dr changed the title Update README Docs: Update README Aug 1, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Aug 1, 2022

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1337 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit 05b8f94 here (report will disappear after 90 days).

Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✨ Thank you @isabelle-dr!

@github-actions
Copy link
Contributor

github-actions bot commented Aug 1, 2022

Thank you for this contribution! 🍰✨🦄

Information about source corruption

0 out of 1337 sources are corrupted.

Acceptance test details

The changes in this pull request did not trigger any new errors on known GTFS datasets from the MobilityDatabase.
Download the full acceptance test report for commit e8836a0 here (report will disappear after 90 days).

@maximearmstrong maximearmstrong merged commit efc8d69 into master Aug 1, 2022
@maximearmstrong maximearmstrong deleted the update-readme-with-video branch August 1, 2022 19:48
@isabelle-dr
Copy link
Contributor Author

Thank you @maximearmstrong for making this amazing interface!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants