feat: bump docs
This commit is contained in:
52
README.md
52
README.md
@@ -1,9 +1,10 @@
|
||||
# andrejusk/dotfiles
|
||||
|
||||
[](https://github.com/andrejusk/dotfiles/actions/workflows/ci.yml)
|
||||
[](https://github.com/andrejusk/dotfiles/actions/workflows/ci.yml)
|
||||
|
||||
My collection of dotfiles and install scripts
|
||||
to set up reproducible dev environments
|
||||
to set up development environments
|
||||
🛠️ 📂️ 🚀
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -11,7 +12,17 @@ A local repository can be installed by running:
|
||||
|
||||
./script/install
|
||||
|
||||
### Automated install
|
||||
<details>
|
||||
<summary>
|
||||
Environment configuration for <code>install</code> script
|
||||
</summary>
|
||||
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| `LOG_TARGET` | File to log installation output to (default: `~/.dotfiles/logs/install-{date}.log`) |
|
||||
</details>
|
||||
|
||||
### Automated setup
|
||||
|
||||
This repository can be installed without a local copy
|
||||
by invoking the `setup` script directly via `curl`:
|
||||
@@ -22,28 +33,17 @@ by invoking the `setup` script directly via `curl`:
|
||||
# Run
|
||||
curl -s https://raw.githubusercontent.com/andrejusk/dotfiles/HEAD/script/setup | bash
|
||||
|
||||
## Features
|
||||
|
||||
My dotfiles include configuration for the following tools:
|
||||
<details>
|
||||
<summary>
|
||||
Environment configuration for <code>setup</code> script
|
||||
</summary>
|
||||
|
||||
### Shell
|
||||
|
||||
- zsh
|
||||
|
||||
### Editor
|
||||
|
||||
- vscode
|
||||
|
||||
### Languages
|
||||
|
||||
- node.js (nvm, yarn)
|
||||
- python (pyenv, poetry)
|
||||
|
||||
### Tools
|
||||
|
||||
- git, gh
|
||||
- docker
|
||||
- terraform (+ ls)
|
||||
- gcloud, firebase, awscli
|
||||
- redis cli
|
||||
- kubectl
|
||||
| Variable | Description |
|
||||
| --- | --- |
|
||||
| `DOTFILES_DIR` | Directory to clone the repository into (default: `~/.dotfiles`)
|
||||
| `DOTFILES_SKIP_INSTALL` | Skip running the install script (default: `false`)
|
||||
| `GITHUB_AUTHOR` | GitHub username to use for cloning repositories (default: `andrejusk`) |
|
||||
| `GITHUB_REPO` | GitHub repository name to clone (default: `dotfiles`)
|
||||
| `GITHUB_BRANCH` | GitHub branch to clone (default: `master`)
|
||||
</details>
|
||||
|
||||
Reference in New Issue
Block a user