Update README

* Add shield.io badges
* Add brief description
* Change website to yadm.io
pull/150/head
Tim Byrne 4 years ago
parent f3e4c7d140
commit bd86b66ea8
No known key found for this signature in database
GPG Key ID: 14DB4FC2465A4B12
  1. 46
      README.md

@ -1,7 +1,45 @@
# yadm - Yet Another Dotfiles Manager [![Build Status](https://travis-ci.org/TheLocehiliosan/yadm.svg?branch=master)](https://travis-ci.org/TheLocehiliosan/yadm)
# yadm - Yet Another Dotfiles Manager
Features, usage, examples and installation instructions can be found on the [website](https://thelocehiliosan.github.io/yadm/).
[![Latest Version][releases-badge]][releases-link]
[![Homebrew Version][homebrew-badge]][homebrew-link]
[![Copr Version][copr-badge]][copr-link]
[![License][license-badge]][license-link]<br />
[![Master Update][master-date]][master-commits]
[![Develop Update][develop-date]][develop-commits]
[![Website Update][website-date]][website-commits]<br />
[![Master Status][master-badge]][travis-ci]
[![Develop Status][develop-badge]][travis-ci]
[https://thelocehiliosan.github.io/yadm/](https://thelocehiliosan.github.io/yadm/)
[https://yadm.io/][website-link]
<!-- vim: set spell lbr : -->
[**yadm**][website-link] is a tool for managing [dotfiles][].
* Based on [Git][], with full range of Git's features
* Supports system-specific alternative files
* Encryption of private data using [GnuPG][]
* Customizable initialization (bootstrapping)
Features, usage, examples and installation instructions can be found on the
[website][website-link].
[Git]: https://git-scm.com/
[GnuPG]: https://gnupg.org/
[copr-badge]: https://img.shields.io/badge/dynamic/json.svg?label=copr&prefix=v&query=%24..version&url=https%3A%2F%2Fcopr.fedorainfracloud.org%2Fapi_2%2Fbuilds%3Fproject_id%3D7041%26limit%3D1
[copr-link]: https://copr.fedorainfracloud.org/coprs/thelocehiliosan/yadm/
[develop-badge]: https://img.shields.io/travis/TheLocehiliosan/yadm/develop.svg?label=develop
[develop-commits]: https://github.com/TheLocehiliosan/yadm/commits/develop
[develop-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/develop.svg?label=develop
[dotfiles]: https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory
[homebrew-badge]: https://img.shields.io/homebrew/v/yadm.svg
[homebrew-link]: https://formulae.brew.sh/formula/yadm
[license-badge]: https://img.shields.io/github/license/TheLocehiliosan/yadm.svg
[license-link]: https://github.com/TheLocehiliosan/yadm/blob/master/LICENSE
[master-badge]: https://img.shields.io/travis/TheLocehiliosan/yadm/master.svg?label=master
[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
[releases-link]: https://github.com/TheLocehiliosan/yadm/releases
[travis-ci]: https://travis-ci.org/TheLocehiliosan/yadm/branches
[website-commits]: https://github.com/TheLocehiliosan/yadm/commits/gh-pages
[website-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/gh-pages.svg?label=website
[website-link]: https://yadm.io/

Loading…
Cancel
Save