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

Update and improve README #155

Open
BillSwirrl opened this issue Oct 28, 2018 · 1 comment
Open

Update and improve README #155

BillSwirrl opened this issue Oct 28, 2018 · 1 comment
Assignees

Comments

@BillSwirrl
Copy link
Member

The instructions in the README of the repository could be improved to make it easier for new users. Also some of the examples no longer work with the example repository - we should go through and check each one and update them where necessary.

Additional things I would find useful:

  • an example showing how to list the dimensions of a dataset (there is one, but it doesn't work)
  • an example showing how to list the possible values of one specific dimension
  • more explanation of the approach to filtering a dataset by fixing the value of one or more dimensions
  • documentation on how to access a graphql endpoint programmatically eg GET /graphql?query= or POST to /graphql with details and an example of what the payload must be
  • some hints on how to use the Documentation Explorer of the interactive graphql interface to find out relevant things for using cubiql
@zeginis zeginis self-assigned this Oct 30, 2018
@zeginis
Copy link
Contributor

zeginis commented Oct 30, 2018

@BillSwirrl I can fix this issue.

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

No branches or pull requests

2 participants