Skip to content

Commit

Permalink
chore: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurMialon committed Dec 12, 2024
1 parent 9c92a76 commit 5a591f5
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@
[Cliffy](https://cliffy.io/) inspired by
[GNU Stow](https://www.gnu.org/software/stow/)

## Table of Contents

- [Installation](#installation)
- [Concepts](#concepts)
- [Features](#features)
- [Getting Started](#getting-started)
- [Commands](#commands)
- [Init](#init)
- [Link](#link)
- [Unlink](#unlink)
- [Config](#config)
- [Add](#add)
- [Edit](#edit)
- [Upgrade](#upgrade)
- [Ignore](#ignore)

## Installation

`curl -fsSL https://raw.githubusercontent.com/arthurmialon/dot/main/install.sh | bash`
Expand Down Expand Up @@ -239,7 +255,7 @@ dot upgrade

---

### Ignore
## Ignore folder and files

Create a `.dotignore` file to avoid link some files or folders. It follows the
same rules as `.gitignore`. By default it always ignore the `.git` folder and
Expand All @@ -254,9 +270,3 @@ the `.dotignore` file.
# Ignore the script
scripts/
```

## Todo

- Add upgrade commande
- Add colors
- Improve bundle size

0 comments on commit 5a591f5

Please sign in to comment.