admin/topgrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added Documentation reference in Readme

Browse Source
This commit is contained in:
Thomas Schönauer
2022-10-16 19:55:08 +02:00
parent 16566ea697
commit ec6da2f18c
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,11 +1,10 @@
![Topgrade](doc/topgrade.png) ![Topgrade](doc/topgrade.png)
<!---
[![Travis](https://api.travis-ci.org/r-darwish/topgrade.svg?branch=master)](https://travis-ci.org/r-darwish/topgrade)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/github/r-darwish/topgrade?svg=true)](https://ci.appveyor.com/project/r-darwish/topgrade)
![GitHub release](https://img.shields.io/github/release/r-darwish/topgrade.svg) ![GitHub release](https://img.shields.io/github/release/r-darwish/topgrade.svg)
[![Crates.io](https://img.shields.io/crates/v/topgrade.svg)](https://crates.io/crates/topgrade) [![Crates.io](https://img.shields.io/crates/v/topgrade.svg)](https://crates.io/crates/topgrade)
[![AUR](https://img.shields.io/aur/version/topgrade.svg)](https://aur.archlinux.org/packages/topgrade/) [![AUR](https://img.shields.io/aur/version/topgrade.svg)](https://aur.archlinux.org/packages/topgrade/)
![homebrew](https://img.shields.io/homebrew/v/topgrade.svg) ![homebrew](https://img.shields.io/homebrew/v/topgrade.svg) -->
--->
![Demo](doc/screenshot.gif) ![Demo](doc/screenshot.gif)
@@ -23,6 +22,9 @@ The compiled binaries contain a self-upgrading feature.
Topgrade requires Rust 1.51 or above. Topgrade requires Rust 1.51 or above.
## Documentation[WIP]
You can visit the documentation at [topgrade-rs.github.io](https://topgrade-rs.github.io/) .
## Usage ## Usage
Just run `topgrade`. Just run `topgrade`.
See [the wiki](https://github.com/r-darwish/topgrade/wiki/Step-list) for the list of things Topgrade supports. See [the wiki](https://github.com/r-darwish/topgrade/wiki/Step-list) for the list of things Topgrade supports.