Skip to content

Commit 69bcaca

Browse files
authored
docs: include video showcase in README.md (#259)
1 parent 072b59b commit 69bcaca

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,19 @@ bash <(curl -s https://raw.githubusercontent.com/CodelyTV/dotly/HEAD/installer)
3636
You can safely install additional software and make any changes to the file system. Once you exit zsh the image is
3737
deleted.
3838

39-
Using Alpine:
39+
<details>
40+
<summary>Using Alpine:</summary>
4041

4142
```bash
4243
docker run -e TERM -e COLORTERM -e LC_ALL=C.UTF-8 -w /root -it --rm alpine sh -uec '
4344
apk add curl sudo bash zsh git g++ python3
4445
bash -c "$(curl -fsSL https://raw.githubusercontent.com/CodelyTV/dotly/HEAD/installer)"
4546
zsh'
4647
```
48+
</details>
4749

48-
Or using Ubuntu:
50+
<details>
51+
<summary>Or using Ubuntu:</summary>
4952

5053
```bash
5154
docker run -e TERM -e COLORTERM -w /root -it --rm ubuntu sh -uec '
@@ -54,6 +57,7 @@ docker run -e TERM -e COLORTERM -w /root -it --rm ubuntu sh -uec '
5457
su -c bash -c "$(curl -fsSL https://raw.githubusercontent.com/CodelyTV/dotly/HEAD/installer)"
5558
su -c zsh'
5659
```
60+
</details>
5761

5862
## Restore your Dotfiles manually
5963

@@ -77,7 +81,7 @@ Using curl
7781
bash <(curl -s https://raw.githubusercontent.com/CodelyTV/dotly/HEAD/restorer)
7882
```
7983

80-
You need to know your GitHub username, repository and install ssh key if your repository is private.
84+
🔒 You need to know your GitHub username, repository and install ssh key if your repository is private.
8185

8286
It also supports other git repos, but you need to know your git repository url.
8387

@@ -95,7 +99,7 @@ git commit -m "Initial commit" &&
9599
git push origin main
96100
```
97101

98-
It's recommended to commit every time you add/modify a config or script.
102+
⚠️ It's recommended to commit every time you add/modify a config or script.
99103

100104
### 🌚 The `dot` command
101105

@@ -127,7 +131,7 @@ Usage:
127131

128132
### ⚙️ Versioning configs
129133

130-
dotly facilites you to version your apps config files. Once you've found the config to version you should:
134+
dotly allows you to version your apps' config files. Once you've found the config to version you should:
131135

132136
1. Copy your config file inside your dotfiles so this will be the source of truth.
133137
E.g. `cp ~/Library/Application Support/Code/User/settings.json $DOTFILES_PATH/editors/code/settings.json`
@@ -191,6 +195,12 @@ You can see the default aliases [here](dotfiles_template/shell/aliases.sh). The
191195
* `la`: ls all files/dirs with colors
192196
* `up`: Update all your package managers packages
193197

198+
## 📽️ Feature showcase (Spanish)
199+
200+
For an in-depth look at the features offered by dotly, you can take a look at [this video](https://www.youtube.com/watch?v=kCBvPb8qAAE):
201+
202+
[![Watch the video](https://img.youtube.com/vi/kCBvPb8qAAE/maxresdefault.jpg)](https://youtu.be/kCBvPb8qAAE)
203+
194204
## ⁉️ Troubleshooting
195205

196206
You can execute `dot self debug` in parallel with another command to see the errors output.

0 commit comments

Comments
 (0)