release-engineering/repo-autoindex
1
0
Fork 0
mirror of https://github.com/release-engineering/repo-autoindex.git synced 2025-02-23 21:52:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Improve README

Browse source
This commit is contained in:
Rohan McGovern 2022-08-15 09:30:43 +10:00
parent 179de1b0c3
commit 6900caa7a7
2 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,7 +1,16 @@
# repo-autoindex-prototype
# repo-autoindex
Generate static HTML indexes of various repository types
## Usage example
![Build Status](https://github.com/release-engineering/repo-autoindex/actions/workflows/ci.yml/badge.svg?branch=main)
![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
[![Docs](https://img.shields.io/website?label=docs&url=https%3A%2F%2Frelease-engineering.github.io%2Frepo-autoindex%2F)](https://release-engineering.github.io/repo-autoindex/)
[![PyPI](https://img.shields.io/pypi/v/repo-autoindex)](https://pypi.org/project/repo-autoindex/)
## Overview
`repo-autoindex` provides a minimal CLI and Python library to generate static HTML indexes
for certain types of content, such as yum repositories.
```
pip install repo-autoindex
@ -9,3 +18,10 @@ REPO_URL=$(curl -s 'https://mirrors.fedoraproject.org/mirrorlist?repo=updates-re
repo-autoindex $REPO_URL
xdg-open index.html
```
See [the manual](https://release-engineering.github.io/repo-autoindex/) for more
information about the usage of `repo-autoindex`.
## License
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

4
pyproject.toml
View file

@ -4,6 +4,10 @@ version = "0.2.0"
description = "Generic static HTML indexes of various repository types"
authors = ["Rohan McGovern <rmcgover@redhat.com>"]
license = "GPLv3"
readme = "README.md"
homepage = "https://github.com/release-engineering/repo-autoindex"
repository = "https://github.com/release-engineering/repo-autoindex"
[tool.poetry.dependencies]
python = ">=3.9,<4"