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

write readme #4

Open
PietrH opened this issue Jan 4, 2023 · 2 comments · Fixed by #13 or #1
Open

write readme #4

PietrH opened this issue Jan 4, 2023 · 2 comments · Fixed by #13 or #1
Assignees
@PietrH
Labels
documentation Improvements or additions to documentation

Comments

@PietrH
Copy link
Member

PietrH commented Jan 4, 2023

The readme should include a description of what this repo/package is, how to use the api (refer to etn, but also short examples on how to make curl/httr requests), needed credentials to use the service and maintenance information.

It would also be nice to setup github actions for testing, and have some badges on the readme.
@PietrH PietrH added the documentation Improvements or additions to documentation label Jan 4, 2023
@PietrH PietrH self-assigned this Jan 4, 2023
@peterdesmet
Copy link
Member

If we want to include examples, I would opt for a README.Rmd (that is translated by devtools::build_readme() to a .md). Use usethis::use_readme_rmd() to initalize this.

This was linked to pull requests Feb 9, 2023
update dev #13
Merged
adapt get_acoustic_detections.R to receive credentials as arguments #1
Merged
@PietrH
Copy link
Member Author

PietrH commented Feb 9, 2023

Implemented in #1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PietrH PietrH

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
2 participants
@peterdesmet @PietrH