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

Add "real-world" field examples to README under Usage Example(s) #345

Open
alexsoble opened this issue May 20, 2019 · 2 comments
Open

Add "real-world" field examples to README under Usage Example(s) #345

alexsoble opened this issue May 20, 2019 · 2 comments

Comments

@alexsoble
Copy link

As a newcomer to this project, I expected the "Usage Example" section of the README to provide a few examples of how this project is being used (or is intended to be used) in the transportation space.

I would suggest adding a few such examples to the top of the README, so that newcomers to the project can better understand how the project is being used.

I might give the current content under "Usage Example" a new section heading, like "Demo" or "Local Demo."

@alexsoble
Copy link
Author

☝️ As an outside collaborator I don't have the ability to tag issues with labels, but if I did I would label this as "suggestion" ... since it's meant as a friendly suggestion from a newcomer. 😄

@hmusavi
Copy link
Collaborator

hmusavi commented May 20, 2019

Thank you for the constructive suggestion. We'll consider them for the next release and seek Product Owner approval.

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

No branches or pull requests

3 participants