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

chore: improve README #254

Merged

Conversation

TheOneWithTheBraid
Copy link
Contributor

I figured out the Structure section of the README was missing the borderColor column, moreover a description of the hexagon and trapezoid section. Additionally, we were lacking an example with borderColor set. I replaced the first example (since the corresponding entry does no longer exist) with a new example of one of the few lines with both a borderColor and a wikidataQid set ; in this case the ALEX RE 23.

I moreover added detailed samples of the hexagon and trapezoid shapes rather than the comment "Other shapes".

  • adds missing borderColor description
  • improves trapezoid and hexagon shape descrptions
  • removes deprecated Go-Ahead Bayern example
  • adds new Alex DLB example with both borderColor and wikidataQid set
  • adds new Hadag trapezoid shape sample
  • adds new Hamburger Hochbahn hexagon shape sample
  • removes deprecated "Other shapes" section

Related: #253 and Traewelldroid/traewelldroid#465

- adds missing `borderColor` description
- improves `trapezoid` and `hexagon` shape descrptions
- removes deprecated Go-Ahead Bayern example
- adds new Alex DLB example with both `borderColor` and `wikidataQid`
  set
- adds new Hadag trapezoid shape sample
- adds new Hamburger Hochbahn hexagon shape sample
- removes deprecated "Other shapes" section

Signed-off-by: The one with the braid <info@braid.business>
@MrKrisKrisu MrKrisKrisu merged commit 8d5e08b into Traewelling:main Dec 24, 2024
2 checks passed
@TheOneWithTheBraid TheOneWithTheBraid deleted the braid/readme-examples branch December 24, 2024 14:26
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