Skip to content

Commit 8497bc3

Browse files
committed
build(docs): generate docs (#57)
1 parent f88797d commit 8497bc3

File tree

3 files changed

+1731
-1414
lines changed

3 files changed

+1731
-1414
lines changed

.gitignore

+9-18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Created by https://www.toptal.com/developers/gitignore/api/python,node,go,zsh,sonar,java,maven,intellij+all,terraform,linux
2-
# Edit at https://www.toptal.com/developers/gitignore?templates=python,node,go,zsh,sonar,java,maven,intellij+all,terraform,linux
1+
# Created by https://www.toptal.com/developers/gitignore/api/python,go,zsh,sonar,java,maven,intellij+all,node,helm,terraform
2+
# Edit at https://www.toptal.com/developers/gitignore?templates=python,go,zsh,sonar,java,maven,intellij+all,node,helm,terraform
33

44
### Go ###
55
# If you prefer the allow list template instead of the deny list, see community template:
@@ -24,6 +24,10 @@
2424
# Go workspace file
2525
go.work
2626

27+
### Helm ###
28+
# Chart dependencies
29+
**/charts/*.tgz
30+
2731
### Intellij+all ###
2832
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
2933
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
@@ -138,21 +142,6 @@ fabric.properties
138142
hs_err_pid*
139143
replay_pid*
140144

141-
### Linux ###
142-
*~
143-
144-
# temporary files which can be created if a process still has a handle open of a deleted file
145-
.fuse_hidden*
146-
147-
# KDE directory preferences
148-
.directory
149-
150-
# Linux trash folder which might appear on any partition or disk
151-
.Trash-*
152-
153-
# .nfs files are created when an open file is removed but is still being accessed
154-
.nfs*
155-
156145
### Maven ###
157146
target/
158147
pom.xml.tag
@@ -553,7 +542,7 @@ zsdoc/data
553542
/tests/_output/*
554543
!/tests/_output/.gitkeep
555544

556-
# End of https://www.toptal.com/developers/gitignore/api/python,node,go,zsh,sonar,java,maven,intellij+all,terraform,linux
545+
# End of https://www.toptal.com/developers/gitignore/api/python,go,zsh,sonar,java,maven,intellij+all,node,helm,terraform
557546
# custom git ignore files
558547
bin
559548
.scannerwork
@@ -567,4 +556,6 @@ TMP_CHANGELOG.md
567556
*.zip
568557
.external_modules
569558
vendor
559+
charts
560+
.DS_Store
570561

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,13 @@ agr 'base-template' 'new-project'
4545
<!-- Include: ./../disclaimer.md -->
4646
<!-- Include: ac:toc -->
4747

48-
### Common
48+
## Common
49+
50+
### Install Dependencies
51+
52+
```bash
53+
task setup
54+
```
4955

5056
## Help
5157

@@ -74,7 +80,7 @@ Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following co
7480

7581
## Copyright
7682

77-
Copyright © 2018-2023 [Hadenlabs](https://hadenlabs.com)
83+
Copyright © 2018-2024 [Hadenlabs](https://hadenlabs.com)
7884

7985
## Trademarks
8086

0 commit comments

Comments
 (0)