diff --git a/README.md b/README.md index 5533d9b..d6661e3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Python UrBackup ![Icon](https://www.urbackup.org/favicon.ico) +# Python UrBackup [![urbackup.org](docs/urbackup.png)](https://www.urbackup.org/) [![PyPI](https://img.shields.io/pypi/v/python-urbackup)](https://pypi.org/project/python-urbackup/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dirconfig) @@ -6,7 +6,7 @@ [![Coverage Status](https://coveralls.io/repos/github/judahpaul16/python-urbackup/badge.svg)](https://coveralls.io/github/judahpaul16/python-urbackup?branch=master) [![Documentation Status](https://readthedocs.org/projects/python-urbackup/badge/?version=latest)](https://python-urbackup.readthedocs.io/en/latest/?badge=latest) -Python wrapper to access and control an UrBackup server. +Python UrBackup is a powerful Python wrapper designed to interact with UrBackup servers. This library allows you to manage backups, restore operations, and monitor the server status programmatically. *Originally [urbackup-server-web-api-wrapper](https://github.com/uroni/urbackup-server-python-web-api-wrapper)* @@ -114,7 +114,7 @@ for client in clients: lastbackup=lastbackup, clientname=client["name"] ) ) ``` -For more information, refer to the [documentation](https://python-urbackup.readthedocs.io/en/latest/). +For more information, please refer to the [API Reference](https://python-urbackup.readthedocs.io/en/latest/api_reference/). ## Contributing 🤝 diff --git a/docs/index.md b/docs/index.md index 0c893b7..f123ae5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,14 @@ -# Python UrBackup ![Icon](https://www.urbackup.org/favicon.ico) +# Python UrBackup [![urbackup.org](urbackup.png)](https://www.urbackup.org/) +[![PyPI](https://img.shields.io/pypi/v/python-urbackup)](https://pypi.org/project/python-urbackup/) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dirconfig) +[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/judahpaul16/python-urbackup/workflow.yaml)](https://github.com/judahpaul16/python-urbackup/actions) +[![Coverage Status](https://coveralls.io/repos/github/judahpaul16/python-urbackup/badge.svg)](https://coveralls.io/github/judahpaul16/python-urbackup?branch=master) +[![Documentation Status](https://readthedocs.org/projects/python-urbackup/badge/?version=latest)](https://python-urbackup.readthedocs.io/en/latest/?badge=latest) Python UrBackup is a powerful Python wrapper designed to interact with UrBackup servers. This library allows you to manage backups, restore operations, and monitor the server status programmatically. +*Originally [urbackup-server-web-api-wrapper](https://github.com/uroni/urbackup-server-python-web-api-wrapper)* + ## Features - Easy to use Python API. diff --git a/docs/urbackup.ico b/docs/urbackup.ico new file mode 100644 index 0000000..ea5e13d Binary files /dev/null and b/docs/urbackup.ico differ diff --git a/docs/urbackup.png b/docs/urbackup.png new file mode 100644 index 0000000..f18ec5f Binary files /dev/null and b/docs/urbackup.png differ