summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHenrique Alves <henriquelalves@gmail.com>2023-05-08 12:19:44 -0300
committerHenrique Alves <henriquelalves@gmail.com>2023-05-08 12:19:44 -0300
commitb42d5e35026b0d7b9b1e584f69e0dc1522ab8298 (patch)
tree46fc30ea1227baca87663303b16d89dba1d116f2 /README.md
parentcd65ce204f4e2439d00ac48095f5a65f7308a8ee (diff)
downloadglam-b42d5e35026b0d7b9b1e584f69e0dc1522ab8298.tar.gz
glam-b42d5e35026b0d7b9b1e584f69e0dc1522ab8298.tar.bz2
glam-b42d5e35026b0d7b9b1e584f69e0dc1522ab8298.zip
add gifs
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 59c81ff..7adbaae 100644
--- a/README.md
+++ b/README.md
@@ -10,25 +10,34 @@ The project only works on UNIX (Linux/Mac) machines. You need `git` installed fo
## Example
You can initialize your project (with meaningful `.gitignore` and `.gdignore` files) with:
+
```
glam init
```
+![](init_example.gif)
+
You can add new addon repositories with:
```
glam add https://github.com/henriquelalves/GodotTIE
```
+![](add_example.gif)
+
If you want to use ✨GLAM✨ with a CI/CD, you can `.gitignore` the `addons/` folder and install all addons listed in the `.glam` file with:
```
glam install
```
+![](install_example.gif)
+
If you are developing an Addon, you can apply changes made in the addon to their `.glam.d` repository with:
```
-glam apply GodotTIE
+glam apply
```
+![](apply_example.gif)
+
## Disclaimer
**This project is a WIP!** This is a beta release to anyone interested in using or contributing to this project. It may contain bugs that may ruin your project if you don't make any backups or use version-control wisely.