Skip to content

Commit

Permalink
chore: Include guides with examples for library's API use
Browse files Browse the repository at this point in the history
  • Loading branch information
aivruu committed Aug 25, 2024
1 parent e56b0b5 commit e1ad883
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# repo-viewer

[![](https://jitpack.io/v/aivruu/repo-viewer.svg)](https://jitpack.io/#aivruu/repo-viewer)
# repo-viewer | [![](https://jitpack.io/v/aivruu/repo-viewer.svg)](https://jitpack.io/#aivruu/repo-viewer)

`repo-viewer` is a library that provides utilities to obtain GitHub repositories information since HTTP requests, and allow download assets of the releases for the requested repositories of an easily way.

> [!NOTE]\
> This is a library that I created to testing HTTP utilities with Java. I taken as base [OcZi/release-watcher](https://github.com/OcZi/release-watcher) for the main idea of this project.
> I started this project with the only propuse of testing HTTP utilities with Java. I taken as base [OcZi/release-watcher](https://github.com/OcZi/release-watcher) for the main idea of this project.
### Features
## Features
* View specified repository's information.
* Easy to usage.
* Download assets from each repository release.

### Download
## Guides
* [Download assets from the repository's latest-release.](https://github.com/aivruu/repo-viewer/blob/main/docs/download-assets-guide.md)
* [Make a request to an specified repository.](https://github.com/aivruu/repo-viewer/blob/main/docs/make-request-guide.md)

## Download
```kotlin
repositories {
maven("https://jitpack.io/")
Expand All @@ -24,7 +26,7 @@ dependencies {
}
```

### Building
## Building
This project require Gradle for building and management, and Java 21 as minimum.
```
git clone https://github.com/aivruu/repo-viewer.git
Expand Down

0 comments on commit e1ad883

Please sign in to comment.