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

Update README #19

Open
CasperWA opened this issue Feb 12, 2021 · 2 comments
Open

Update README #19

CasperWA opened this issue Feb 12, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@CasperWA
Copy link
Member

The README needs an update to document how to install, run, and use this repository and package.
@CasperWA CasperWA added the documentation Improvements or additions to documentation label Feb 12, 2021
@CasperWA
Copy link
Member Author

CasperWA commented Mar 8, 2021

From @csadorf:

  • It would be good to have a basic example query flow as part of the README.

@CasperWA
Copy link
Member Author

CasperWA commented May 3, 2021 •
edited
Loading

I suggest to add a Usage page for this instead of putting it directly in the README. This can then be linked to from the README, and therefore also the landing page of the documentation at optimade.org/optimade-gateway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CasperWA