Skip to content

Commit

Permalink
small changes in readme + beautify code
Browse files Browse the repository at this point in the history
  • Loading branch information
Staubgeborener committed Feb 14, 2024
1 parent 6c15e9d commit 67929a3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# klipper-backup 💾
Klipper backup script for manual or automated GitHub backups

This is a backup script to create manual or automated klipper backups in a github repository. You can [see an example](https://github.com/Staubgeborener/3dprint) of what it looks like in the end.
# Klipper-Backup 💾
Klipper-Backup is a script for manual or automated GitHub backups. It's Lightweight, pragmatic and comfortable.

## RTFM
I would suggest reading the [docs](https://staubgeborener.github.io/klipper-backup), as this provides detailed step-by-step instructions.
I would suggest reading the [docs](https://staubgeborener.github.io/klipper-backup), as this provides detailed step-by-step instructions and further tips.

> [!IMPORTANT]
> If you have already used the script before release 1.0, please read [this wiki article](https://staubgeborener.github.io/klipper-backup/migration) before opening an issue!
> If you have already used the script before release 1.0, please read [this docs section](https://staubgeborener.github.io/klipper-backup/migration) before opening an issue!
## YouTube
The user [Minimal 3DP](https://github.com/minimal3dp) has created a video about the initial setup and use of klipper-backup and made it available on YouTube. This and the wiki should explain many questions in advance.
[Minimal 3DP](https://github.com/minimal3dp) has created a video about the initial setup and use of Klipper-Backup and made it available on YouTube. This and the wiki should explain many questions in advance.

[![The Ultimate Guide to Using Klipper Macros to Backup Your Configuration Files](https://img.youtube.com/vi/J4_dlCtZY48/0.jpg)](https://www.youtube.com/watch?v=J4_dlCtZY48 "The Ultimate Guide to Using Klipper Macros to Backup Your Configuration Files")
1 change: 0 additions & 1 deletion script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ cp "$parent_path"/.gitignore "$backup_path/.gitignore"
echo -e "# klipper-backup 💾 \nKlipper backup script for manual or automated GitHub backups \n\nThis backup is provided by [klipper-backup](https://github.com/Staubgeborener/klipper-backup)." > "$backup_path/README.md"

# Individual commit message, if no parameter is set, use the current timestamp as commit message

if [ -n "$1" ]; then
commit_message="$@"
else
Expand Down

0 comments on commit 67929a3

Please sign in to comment.