Skip to content

Commit

Permalink
docs(readme): update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yunielrc committed Oct 8, 2023
1 parent d7f43ee commit 178a272
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 8 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
**_Declare your working environment and Automate its configuration_**

**_New member on the team?, reproduce your colleague working environment and start working now_**

**_And the most important, this is a democratic project not a dictatorship, so you have the freedom to join to it and build the new features you need for the benefit of everyone_**

</div>

<a href="https://www.producthunt.com/posts/ydf?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-ydf" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=416013&theme=light" alt="ydf - A&#0032;disruptive&#0032;dotfiles&#0032;manager&#0043; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
Expand Down Expand Up @@ -315,11 +318,11 @@ The disadvantages of this approach are:

1. it's not modular, so you can't make a custom pick of packages to install
2. loss of the relationship between tool installation and configuration
3. breaks the principle of high cohesion and low coupling
3. it breaks the principle of high cohesion and low coupling
4. no suitable for sharing, because #1
5. no `packages selection`
6. no `substitution variables`
7. no instructions others than `homelnr`
7. no instructions other than `homelnr`

## Usage

Expand Down Expand Up @@ -397,13 +400,26 @@ git push -u origin master

### Install packages

When you reinstall your OS or on a new machine you can install all your
packages with:
When you reinstall your OS or on a new machine you can:

Install packages from a `packages selection` file

```sh
ydf package install <packages_selection>.pkgs
```

Install some packages

```sh
ydf package install <package1> <package2> ...
```

Install one package

```sh
ydf package install <package>
```

👉 You can test the installation of the packages on a virtual machine before
install them on a real one.

Expand Down
24 changes: 20 additions & 4 deletions README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
**_Declare your working environment and Automate its configuration_**

**_New member on the team?, reproduce your colleague working environment and start working now_**

**_And the most important, this is a democratic project not a dictatorship, so you have the freedom to join to it and build the new features you need for the benefit of everyone_**

</div>

<a href="https://www.producthunt.com/posts/ydf?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-ydf" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=416013&theme=light" alt="ydf - A&#0032;disruptive&#0032;dotfiles&#0032;manager&#0043; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
Expand Down Expand Up @@ -293,11 +296,11 @@ The disadvantages of this approach are:

1. it's not modular, so you can't make a custom pick of packages to install
2. loss of the relationship between tool installation and configuration
3. breaks the principle of high cohesion and low coupling
3. it breaks the principle of high cohesion and low coupling
4. no suitable for sharing, because #1
5. no `packages selection`
6. no `substitution variables`
7. no instructions others than `homelnr`
7. no instructions other than `homelnr`

## Usage

Expand Down Expand Up @@ -364,13 +367,26 @@ git push -u origin master

### Install packages

When you reinstall your OS or on a new machine you can install all your
packages with:
When you reinstall your OS or on a new machine you can:

Install packages from a `packages selection` file

```sh
ydf package install <packages_selection>.pkgs
```

Install some packages

```sh
ydf package install <package1> <package2> ...
```

Install one package

```sh
ydf package install <package>
```

👉 You can test the installation of the packages on a virtual machine before
install them on a real one.

Expand Down

0 comments on commit 178a272

Please sign in to comment.