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.

Sign up for GitHub

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

Jump to bottom

README is way too complex #8

Closed
tpennypacker opened this issue Apr 6, 2022 · 4 comments
Closed

README is way too complex #8

tpennypacker opened this issue Apr 6, 2022 · 4 comments
Assignees
@lebca
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@tpennypacker
Copy link

It took two experienced developers 10 minutes of close reading to figure out what you actually do. The first line of the readme should accurately convey to the layman what the product does in its simplest form.

Example:

Welcome to MetricFlow

We create SQL queries that you can reuse.
@tpennypacker tpennypacker added bug Something isn't working triage Tasks that need to be triaged labels Apr 6, 2022
@tlento tlento added documentation Improvements or additions to documentation and removed triage Tasks that need to be triaged labels Apr 6, 2022
@vishnuravi
Copy link

I think including a real-world example would go a long way to making the README easier to understand.

@tlento
Copy link
Contributor

tlento commented Apr 6, 2022

Agree we need a more direct opening, and we're working on a simple example as well. Thanks for the input!

@tlento tlento mentioned this issue Apr 7, 2022
Open
@tlento
Copy link
Contributor

tlento commented Apr 7, 2022

#7 adds an opening which should address the core of this issue. Feedback welcome!

Also, filed #20 about the real world examples, because I think that merits separate discussion.

@vishnuravi
Copy link

#7 adds an opening which should address the core of this issue. Feedback welcome!

The opening is very clear now, thank you for addressing this so quickly!

@tlento tlento closed this as completed Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lebca lebca

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@vishnuravi @tlento @lebca @tpennypacker