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 README.md #70

Conversation

daralynnrhode
Copy link
Contributor

ReadMe update

Overview

Additions made to the ReadMe that will link the page to the data-access api webpage. Also updated any out of date outputs.

New Dependencies

New Files

Deleted Files

Updated Files

  • ReadMe

Testing

@daralynnrhode daralynnrhode changed the title [WIP] Update README.md Update README.md Jul 19, 2024
@daralynnrhode daralynnrhode requested review from a team, bourque, sdhoyt, maxinelasp and anamanica and removed request for a team July 19, 2024 15:10
Copy link
Contributor

@greglucas greglucas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions, but overall looks great.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Greg Lucas <greg.m.lucas@gmail.com>
Copy link
Contributor

@bourque bourque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Comment on lines +19 to +25
### Base Command Arguments
```bash
$ imap-data-access query # or
$ imap-data-access download # or
$ imap-data-access upload
```
Add the '-h' help flag with any base command for more information
Copy link
Contributor

@bourque bourque Jul 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea to include the bear-bones usage here for quick reference. I think between this and the link to the more detailed instructions, it is a good balance.

@daralynnrhode daralynnrhode merged commit c55f462 into IMAP-Science-Operations-Center:main Jul 22, 2024
13 checks passed
@daralynnrhode daralynnrhode deleted the document_update branch July 22, 2024 19:37
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

Successfully merging this pull request may close these issues.

3 participants