diff options
author | Jerry Jacobs <jerry.jacobs@xor-gate.org> | 2016-01-15 19:06:20 +0100 |
---|---|---|
committer | Jerry Jacobs <jerry.jacobs@xor-gate.org> | 2016-01-15 20:02:42 +0100 |
commit | a1e1ce552c466ce822b10dbf837be897a271f41d (patch) | |
tree | 91112eaeb5be93d53b0a1f13f46372ebae9096ed /README.rst | |
parent | 37179451bffe2274a0b3573d79be04d0af74b592 (diff) |
Update README.md with doc|stable shield, minor markup fixes on docs/deployment.rst
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/README.rst b/README.rst index 2a6814792..780a914ea 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,8 @@ |screencast| -.. |screencast| image:: https://asciinema.org/a/28691.png - :alt: BorgBackup Installation and Basic Usage - :target: https://asciinema.org/a/28691?autoplay=1&speed=2 - - What is BorgBackup? =================== + BorgBackup (short: Borg) is a deduplicating backup program. Optionally, it supports compression and authenticated encryption. @@ -165,7 +161,11 @@ THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS. Borg is distributed under a 3-clause BSD license, see `License`_ for the complete license. -|build| |coverage| +|doc| |build| |coverage| + +.. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=stable + :alt: Documentation + :target: http://borgbackup.readthedocs.org/en/stable/ .. |build| image:: https://travis-ci.org/borgbackup/borg.svg :alt: Build Status @@ -174,3 +174,7 @@ for the complete license. .. |coverage| image:: https://codecov.io/github/borgbackup/borg/coverage.svg?branch=master :alt: Test Coverage :target: https://codecov.io/github/borgbackup/borg?branch=master + +.. |screencast| image:: https://asciinema.org/a/28691.png + :alt: BorgBackup Installation and Basic Usage + :target: https://asciinema.org/a/28691?autoplay=1&speed=2 |