From 91c660a813430d5c6c6a86a222a2a6cb02e42555 Mon Sep 17 00:00:00 2001 From: Qekly <71404592+aivruu@users.noreply.github.com> Date: Mon, 26 Aug 2024 15:53:46 -0400 Subject: [PATCH] chore: Include badges and more --- docs/readme.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index f2ffbc4..5627168 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -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