Help us understand the workflow better with Readme.md
Opened this issue · 1 comments
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.
Fair points.
The workflow has a lot of legacy functionality modified over the years and - very often simply not working.