search

greenelab / library-access

Collecting data on whether library access to scholarly literature
Other
5 stars 3 forks source link

Adding more descriptive information to readme #26

Closed jglev closed 6 years ago

jglev commented 6 years ago

This follows a discussion in #14. A bit late in finishing it up, but I hope it will still be useful for readers.

dhimmel commented 6 years ago

Yep. will be useful. Let me know when you're done adding commits on your end.

jglev commented 6 years ago

I think that this level of info. is enough to get others going. Do you agree?

dhimmel commented 6 years ago

I think that this level of info. is enough to get others going. Do you agree?

It seems like the most important thing is undocumented -- what is api_base_url? How would someone go about getting one for their university?

jglev commented 6 years ago

Hmm, I can see how the documentation as it is could be confusing for a reader who's coming in from scratch to parse. This is a documentation difficulty; api_base_url is going to be very different from institution to institution, because it'll be based on whomever that institution contracts with for an OpenURL resolver. And finding out what that base URL is will be different for each institution, as it'll involve asking the local development team (e.g., in the library) for help with it / documentation for it. As we've talked about, it's also the case that different OpenURL resolvers may return slightly different formats of data.

Do you think it would be useful to state the above explicitly in the Readme? If so, do you think that that's sufficient for communicating to users?

dhimmel commented 6 years ago

Do you think it would be useful to state the above explicitly in the Readme? If so, do you think that that's sufficient for communicating to users?

Yes.

jglev commented 6 years ago

Is 5f7d5a0 in line with what you had in mind, too?

dhimmel commented 6 years ago

Squash merged into https://github.com/greenelab/library-access/commit/310d718f8af0f2e519b84dc7ef72c660b858828e