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

Add dependency information for including in project. #142

Merged
merged 1 commit into from
Sep 8, 2016

Conversation

satendrakumar
Copy link

Added dependency information for Maven and SBT so that it is easier for the developers who are new to the library.

Added dependency information for Maven and SBT so that it is easier for the developers who are new to the library.
@retronym
Copy link
Member

retronym commented Oct 9, 2015

Hi @satendrakumar06,

Sorry about the slow response on this PR.

We've actually moved away from including the latest version number in the README because it quite a manual process to update it each release, and it often was out of date.

Instead, we have added the buttons:

image

Which link to a search on the Maven repository. When you click through to a particular version, you get to info for each of the build tools:

image

Unfortunately, this isn't very discoverable. Perhaps we could include some instructions on this process in the README as a compromise? WDYT?

@satendrakumar
Copy link
Author

@retronym Thanks for response.
I agree it makes sense to not include the exact versions. In order for people to know we can add a line that once you click on the button then you would reach the repo.

@dlwh
Copy link

dlwh commented Oct 22, 2015

FWIW, I was just about to submit a PR doing the exact same thing. Buttons aren't really the default in the community and thus surprising. You also can't cmd-f for them...

@satendrakumar
Copy link
Author

@retronym Should I close this pull request ?

@retronym retronym merged commit 92147d8 into scala:master Sep 8, 2016
@retronym
Copy link
Member

retronym commented Sep 8, 2016

Sorry about the delay, I'd forgotten about this PR. I've merged it and will figure out a way to keep the version up to date.

@satendrakumar
Copy link
Author

@retronym Thanks

@satendrakumar satendrakumar deleted the topic/doc-improvement branch September 8, 2016 06:29
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