Skip to content

Commit

Permalink
Fix links in README
Browse files Browse the repository at this point in the history
Signed-off-by: Samuel Giffard <[email protected]>
  • Loading branch information
Samuel Giffard committed Oct 12, 2023
1 parent a37601a commit 1286c5f
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
.. image:: logo.png
.. image:: https://raw.githubusercontent.com/Aiven-Open/rohmu/main/logo.png
:alt: Rohmu logo
:align: center

Rohmu is a Python library for building backup tools for databases
providing functionality for compression, encryption and transferring
data between the database and an object storage. Rohmu supports main
public clouds such as GCP, AWS and Azure for backup storage. Rohmu is
used in various backup tools such as
`PGHoard <https://github.com/aiven/pghoard>`__ for PostgreSQL,
`MyHoard <https://github.com/aiven/myhoard>`__ for MySQL and
`Astacus <https://github.com/aiven/astacus>`__ for M3 and ClickHouse and
`PGHoard <https://github.com/Aiven-Open/pghoard>`__ for PostgreSQL,
`MyHoard <https://github.com/Aiven-Open/myhoard>`__ for MySQL and
`Astacus <https://github.com/Aiven-Open/astacus>`__ for M3 and ClickHouse and
other databases.

Features
========

- Supported object storages: Azure, GCP, S3, Swift (OpenStack), local
file storage and SFTP.
- Supported compression algorithms: Snappy,
- Supported compression algorithms: `Snappy <https://github.com/andrix/python-snappy>`__,
`zstd <https://github.com/facebook/zstd>`__ and
`lzma <https://docs.python.org/3/library/lzma.html>`__.

Expand All @@ -24,15 +26,15 @@ Requirements

Rohmu requires Python >= 3.8. For Python library dependencies, have a
look at
`requirements.txt <https://github.com/aiven/rohmu/blob/main/requirements.txt>`__.
`setup.cfg <https://github.com/Aiven-Open/rohmu/blob/main/setup.cfg>`__.

Usage example
=============

*Add usage example here*

For real-world usage you can have a look at `how Rohmu is used in
PGHoard <https://github.com/aiven/pghoard/blob/main/pghoard/basebackup.py>`__.
PGHoard <https://github.com/Aiven-Open/pghoard/tree/main/pghoard/basebackup>`__.

Development
===========
Expand All @@ -43,7 +45,7 @@ License
=======

Rohmu is licensed under the Apache license, version 2.0. Full license
text is available in the `LICENSE <LICENSE>`__ file.
text is available in the `LICENSE <https://github.com/Aiven-Open/rohmu/blob/main/LICENSE>`__ file.

Please note that the project explicitly does not require a CLA
(Contributor License Agreement) from its contributors.
Expand All @@ -63,7 +65,7 @@ Rohmu was created by and is maintained by `Aiven
<https://aiven.io>`__.

Rohmu was originally a part of `PGHoard
<https://github.com/aiven/pghoard>`__ but was later extracted to its
<https://github.com/Aiven-Open/pghoard>`__ but was later extracted to its
own GitHub project.

The Rohmu logo was created by `@evche-aiven
Expand All @@ -73,11 +75,11 @@ Contact
=======

Bug reports and patches are very welcome, please post them as GitHub
issues and pull requests at https://github.com/aiven/rohmu . To report
issues and pull requests at https://github.com/Aiven-Open/rohmu . To report
any possible vulnerabilities or other serious issues please see our
`security <SECURITY.md>`__ policy.
`security <https://github.com/Aiven-Open/rohmu/blob/main/SECURITY.md>`__ policy.

Copyright
=========

Copyright (C) 2022 Aiven Ltd and contributors to the Rohmu project.
Copyright (C) 2023 Aiven Ltd and contributors to the Rohmu project.

0 comments on commit 1286c5f

Please sign in to comment.