Skip to content

Commit

Permalink
chore: Include badges and more
Browse files Browse the repository at this point in the history
  • Loading branch information
aivruu committed Aug 26, 2024
1 parent 24b2e9b commit 91c660a
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# repo-viewer | [![](https://jitpack.io/v/aivruu/repo-viewer.svg)](https://jitpack.io/#aivruu/repo-viewer)
# repo-viewer | [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2af8dd31da77439ea518ee1df8d725be)](https://app.codacy.com/gh/aivruu/repo-viewer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[![](https://jitpack.io/v/aivruu/repo-viewer.svg)](https://jitpack.io/#aivruu/repo-viewer)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/aivruu/repo-viewer/build.yml)
![GitHub License](https://img.shields.io/github/license/aivruu/repo-viewer)
![GitHub commit activity](https://img.shields.io/github/commit-activity/t/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.
`repo-viewer` permits to get information about GitHub repositories, and any release published for these repositories, besides of allowing download these releases' adjunted assets, providing several functionalities with a decent code-quality and an understandable and very docummented structure.

> [!NOTE]\
> 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
* View specified repository's information.
* View each repository's releases' information.
* Easy to usage.
* Download assets from each repository release.

## Guides
* [Download assets from the repository's latest-release.](https://github.com/aivruu/repo-viewer/blob/main/docs/download-assets-guide.md)
* [Download assets from any repository releases.](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
Expand Down

0 comments on commit 91c660a

Please sign in to comment.