Fix and update README files #33
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
langsmith
commented
Jul 30, 2025
| ## Documentation | ||
|
|
||
| For detailed API documentation, see [audiowaveformview/README.md](audiowaveformview/README.md) | ||
| For detailed API documentation, see [timelineview/README.md](timelineview/README.md) |
Contributor
Author
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
No other important mentions of audiowaveformview
ferPrieto
requested changes
Jul 30, 2025
Owner
ferPrieto
left a comment
ferPrieto
left a comment
There was a problem hiding this comment.
Thanks for the comments. Overall looks good, just a few tweaks in what you've included
| ## Documentation | ||
|
|
||
| For detailed API documentation, see [audiowaveformview/README.md](audiowaveformview/README.md) | ||
| For detailed API documentation, see [timelineview/README.md](timelineview/README.md) |
timelineview/README.md
Outdated
| implementation 'com.github.ferPrieto:timelineview:LATEST_VERSION_NUMBER' | ||
| ``` | ||
|
|
||
| If you're using a `libs.versions.toml` file: |
Owner
There was a problem hiding this comment.
Suggested change
| If you're using a `libs.versions.toml` file: | |
| If you are using Gradle version catalog, through a `libs.versions.toml` file: |
timelineview/README.md
Outdated
|
|
||
| ### 2. Declare Jitpack | ||
|
|
||
| You need to declare Jitpack in your `settings.gradle` file because that's what's used to publish this library |
Owner
There was a problem hiding this comment.
Suggested change
| You need to declare Jitpack in your `settings.gradle` file because that's what's used to publish this library | |
| You must include `jitpack.io` in your `settings.gradle` file, since it's a public dependency``` |
Co-authored-by: Fernando Prieto Moyano <f.prieto.moyano@gmail.com>
Co-authored-by: Fernando Prieto Moyano <f.prieto.moyano@gmail.com>
ferPrieto
approved these changes
Jul 31, 2025
langsmith
deleted the
langston/updating-readme-and-adding-installation-docs
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes and update README files.
#32 made changes to the publishing but didn't add actual explanation docs. This pr does.
This pr is related to my ticket at #31 and the findings I made while trying to set up this library.