This repo could use a README

[glennon]

I get asked a lot about R for doing geyser eruption analysis (especially for Old Faithful data), so it would be useful to have a basic description of this package.

[taltstidl]

This is definitely a must - once the package actually makes its way to a stable release. Currently it is very much a work in progress and there's not really much to write about. Work started over a year ago, but has failed to gain significant traction. More contributors would be welcome.

[hathawayj]

My student decided to do other work and I haven't had any others that wanted to take up the baton. The soonest I will be able to find some support is Fall 2020.

[spkaluzny]

We have a working version of the package. There are several open issues that need to be resolved by someone who knows more about the actual data and the database. I currently have time to devote to the project. Right now I am looking into adding functions to download the geyser locations. I want to be able to add maps to the vignette.

[taltstidl]

@spkaluzny Thanks for getting back with us. I'll take care of responding to any remaining issues as swiftly as I can. Mapping capabilities would certainly be appreciated since it eliminates the need to switch tool context, but it should nevertheless be noted that we provide a web map that people can use.

[spkaluzny]

I edited the README.md that @TR4Android created. I pushed it to what I thought was the add-readme branch, not sure. The add-readme branch includes a quickstart.jpeg. I think we should drop, having a jpeg at the top level of a package will not be allowed on CRAN and don't think it will be important once we have a full vignette.

[taltstidl]

@spkaluzny Thanks for the finishing touches to my messy R code. The add-readme branch is the correct one 👍
We can remove the quickstart.jpeg if it's not allowed on CRAN. I had people in mind that browse GitHub, and in my experience the Readmes there are often heavy in images. I'll delete the actual image and then merge the pull request tomorrow.

[taltstidl]

@hathawayj I've closed this issue since it's specifically for the Readme, but do ping us if you have someone who's willing to work on this package. We'll gladly add that student to this repo. Thanks.