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

Help us understand the workflow better with Readme.md #52

Open
merchako opened this issue Jan 5, 2022 · 1 comment
Open

Help us understand the workflow better with Readme.md #52

merchako opened this issue Jan 5, 2022 · 1 comment
Assignees
Labels
Hot 🔥 High importance

Comments

@merchako
Copy link

merchako commented Jan 5, 2022

I think Readme.md could use some editing and additional writing. Considering how confusing timezone conversion can be, a readme like this requires great clarity, but the phrasing (e.g., "Conversion of a time") in the current version is ambiguous.

It would also be helpful to have one or two conceptual paragraphs. Users come to a product like this with drastically different ideas about how it would work and what it might or might not be able to do. Setting them straight at a high level would clear things up for everyone. For example:

  • What's up with pre-defined zones? Are they just a convenience? Can I basically use all the functionality of the workflow without defining any zones, but they'll make my life easier if I do?
  • Out of the box, (how) can I give 3/4 of these components and get an answer for the missing one: source timezone, source time, destination timezone, destination time?
  • Does the workflow know my current timezone without me telling it?
  • Does it fuzzy match city names for me?
  • Can I look up or output timezones by city name, timezone name, or country name?
  • Can it output a multi-timezone string (e.g., "11pm CST (12pm EST)")?

If you've been frustrated with users submitting issues who are simply using the workflow "wrong", you may be able to improve the situation by taking a red pen to the Readme.

@jaroslawhartman
Copy link
Owner

Fair points.
The workflow has a lot of legacy functionality modified over the years and - very often simply not working.

@jaroslawhartman jaroslawhartman self-assigned this Feb 25, 2024
@jaroslawhartman jaroslawhartman added the Hot 🔥 High importance label Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hot 🔥 High importance
Projects
None yet
Development

No branches or pull requests

2 participants