Skip to content

Commit aa12ccf

Browse files
committed
docs: Update badges in README and delete Why? section
1 parent e6da01d commit aa12ccf

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# gobackup-github
2-
[![Build on multiple platforms](https://github.com/slashtechno/gobackup-github/actions/workflows/go-build.yml/badge.svg)](https://github.com/slashtechno/gobackup-github/actions/workflows/go-build.yml)![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/slashtechno/gobackup-github)[![Create and publish a Docker image](https://github.com/slashtechno/gobackup-github/actions/workflows/docker.yml/badge.svg?branch=main)](https://github.com/slashtechno/gobackup-github/actions/workflows/docker.yml)
3-
Go program that utilizes the Github API to backup all a user's repositories, including repositories that have been stored. Multiple users can be backed up, including all members of a GitHub organization.
2+
[![GitHub Actions Build Workflow Status](https://img.shields.io/github/actions/workflow/status/slashtechno/gobackup-github/go-build.yml?style=for-the-badge&label=Build&labelColor=%2344cc11&color=%23555555)](https://github.com/slashtechno/gobackup-github/actions/workflows/go-build.yml) ![Static Badge](https://img.shields.io/badge/open-source-_?style=for-the-badge&labelColor=%23ef4041&color=%23c13a3a) [![GitHub Actions Docker Workflow Status](https://img.shields.io/github/actions/workflow/status/slashtechno/gobackup-github/docker.yml?style=for-the-badge&label=Docker%20Image%20Build)](https://github.com/slashtechno/gobackup-github/actions/workflows/docker.yml)
3+
4+
Go program that utilizes the Github API to backup a user's repositories, including repositories that have been starred. Multiple users can be backed up, including all members of a GitHub organization.
45
![Demo](demo.gif)
56

67
### Setup and Usage
78
1. Create a Github personal access token with the following scopes: `read:user, repo`
89
2. Either download a binary for your system from releases, or build the program and add it to your PATH with `go install`.
910
3. Copy `config.example.yaml` to `config.yaml` and fill in the fields.
1011
- In addition, command line flags can be used to specify configuration options. Use the `help` command or the `--help` flag for more information.
12+
- It is recommended to read through the `config.example.yaml` file to understand the configuration options.
1113
4. Run the program with `gobackup-github backup`
1214
- To perform a rolling backup, run `gobackup-github backup continuous`
1315

@@ -20,5 +22,5 @@ To create a container that runs on boot and performs a rolling backup every 24 h
2022
#### Docker Compose
2123
You can also just run `docker compose up -d` to start the container with automatic restarts, assuming you have a `docker-compose.yml` file in the same directory as the `config.yaml` file. You can also edit the `docker-compose.yml` file to change configuration and to manage the rolling backup, if needed.
2224

23-
### Why?
24-
I wanted a simple way to backup my Github repositories. I also wanted to learn Go and APIs. Thus, I began this project in 2022 as a way to create my first Go project, use the Github API, and make a utility to backup Github repositories.
25+
### Contributing
26+
Pull Requests are welcome!

0 commit comments

Comments
 (0)