Skip to content

Commit

Permalink
docs: style README (#75)
Browse files Browse the repository at this point in the history
* style: use `---` over `<hr>`

* style: syntax highlight code block

* style: <br> to trailing spaces
  • Loading branch information
scarf005 authored Jan 30, 2023
1 parent 73845d3 commit 5ba05d9
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ or
### Wipe all profiles
`konsave -w` or `konsave --wipe`

<br><hr><br>


---


## Editing the configuration file
You can make changes to Konsave's configuration file according to your needs. The configuration file is located in `~/.config/konsave/config.yaml`.
Expand All @@ -55,7 +56,7 @@ For KDE Plasma users, the configuration file will be pre-configured.

### Format
The configuration file should be formatted in the following way:
```
```yaml
---
save:
name:
Expand All @@ -79,7 +80,7 @@ export:

### Adding more files/folders to backup
You can add more files/folders in the configuration file like this:
```
```yaml
save:
name:
location: "path/to/parent/directory"
Expand Down Expand Up @@ -109,15 +110,15 @@ The best example for this is the ".default-release" folder of firefox.
`${BEGINS_WITH="text"}`: for folders with different names on different computers whose names start with the same thing.


```
```yaml
save:
firefox:
location: "$HOME/.mozilla/firefox/${ENDS_WITH='.default-release'}"
entries:
- chrome
```

<hr>
---

## Contributing
Please read [CONTRIBUTION.md](https://github.com/Prayag2/konsave/blob/master/CONTRIBUTION.md) for info about contributing.
Expand Down

0 comments on commit 5ba05d9

Please sign in to comment.