1- # go-wallheven
1+ # go-wallhaven
22
33<div align =" center " >
44
5- [ ![ Build Status] ( https://img.shields.io/github/checks-status/coderj001/go-wallheven /main?color=black&style=for-the-badge&logo=github )] [ github-actions ]
6- [ ![ Code Coverage] ( https://img.shields.io/codecov/c/github/coderj001/go-wallheven ?color=blue&logo=codecov&style=for-the-badge )] [ github-actions-tests ]
5+ [ ![ Build Status] ( https://img.shields.io/github/checks-status/coderj001/go-wallhaven /main?color=black&style=for-the-badge&logo=github )] [ github-actions ]
6+ [ ![ Code Coverage] ( https://img.shields.io/codecov/c/github/coderj001/go-wallhaven ?color=blue&logo=codecov&style=for-the-badge )] [ github-actions-tests ]
77[ ![ Security: bandit] ( https://img.shields.io/badge/Security-GoSec-lightgrey?style=for-the-badge&logo=springsecurity )] ( https://github.com/securego/gosec )
88[ ![ Dependencies Status] ( https://img.shields.io/badge/Dependencies-Up%20to%20Date-brightgreen?style=for-the-badge&logo=dependabot )] [ dependabot-pulls ]
99[ ![ Semantic Versioning] ( https://img.shields.io/badge/versioning-semantic-black?style=for-the-badge&logo=semver )] [ github-releases ]
1010[ ![ Pre-Commit Enabled] ( https://img.shields.io/badge/Pre--Commit-Enabled-blue?style=for-the-badge&logo=pre-commit )] [ precommit-config ]
11- [ ![ License] ( https://img.shields.io/github/license/coderj001/go-wallheven ?color=red&style=for-the-badge )] [ project-license ]
11+ [ ![ License] ( https://img.shields.io/github/license/coderj001/go-wallhaven ?color=red&style=for-the-badge )] [ project-license ]
1212[ ![ Go v1.18] ( https://img.shields.io/badge/Go-%20v1.18-black?style=for-the-badge&logo=go )] [ gomod-file ]
1313
14- GoWallheven is a Go application created using https://github.com/notsatan/go-template
15-
1614</div >
1715
1816
1917## Initial Setup
2018
2119This section is intended to help developers and contributors get a working copy of
22- ` go-wallheven ` on their end
20+ ` go-wallhaven ` on their end
2321
2422<details >
2523<summary >
2624 1. Clone this repository
2725</summary ><br >
2826
2927``` sh
30- git clone https://github.com/coderj001/go-wallheven
31- cd go-wallheven
28+ git clone https://github.com/coderj001/go-wallhaven
29+ cd go-wallhaven
3230```
3331</details >
3432
@@ -44,18 +42,18 @@ Install `golangci-lint` from the [official website][golangci-install] for your O
4442
4543## Local Development
4644
47- This section will guide you to setup a fully-functional local copy of ` go-wallheven `
45+ This section will guide you to setup a fully-functional local copy of ` go-wallhaven `
4846on your end and teach you how to use it! Make sure you have installed
4947[ golangci-lint] [ golangci-install ] before following this section!
5048
5149** Note:** This section relies on the usage of [ Makefile] [ makefile-official ] . If you
5250can't (or don't) use Makefile, you can follow along by running the internal commands
53- from [ ` go-wallheven 's ` Makefile] [ makefile-file ] (most of which are
51+ from [ ` go-wallhaven 's ` Makefile] [ makefile-file ] (most of which are
5452OS-independent)!
5553
5654### Installing dependencies
5755
58- To install all dependencies associated with ` go-wallheven ` , run the
56+ To install all dependencies associated with ` go-wallhaven ` , run the
5957command
6058
6159``` sh
@@ -87,7 +85,7 @@ make lint
8785
8886### Running Tests
8987
90- Tests in ` go-wallheven ` are classified as * fast* and * slow* - depending
88+ Tests in ` go-wallhaven ` are classified as * fast* and * slow* - depending
9189on how quick they are to execute.
9290
9391To selectively run tests from either test group, use the Makefile command
@@ -142,9 +140,9 @@ and [all tests](#running-tests) one after the other!
142140| ` fast-tests ` | Selectively run * fast* tests | NA |
143141| ` slow-tests ` | Selectively run * slow* tests | NA |
144142| ` test-suite ` | Check codestyle, run linters and ** all** tests | golangci-lint |
145- | ` run ` | Run * go-wallheven * | NA |
146- | ` docker-gen ` | Create production docker image for * go-wallheven * | docker |
147- | ` docker-debug ` | Create debug-friendly docker image for * go-wallheven * | docker |
143+ | ` run ` | Run * go-wallhaven * | NA |
144+ | ` docker-gen ` | Create production docker image for * go-wallhaven * | docker |
145+ | ` docker-debug ` | Create debug-friendly docker image for * go-wallhaven * | docker |
148146| ` clean-docker ` | Remove docker image generated by ` docker-gen ` | docker |
149147
150148<br >
@@ -181,7 +179,7 @@ directory inside the project directory.
181179The binaries generated will be named in the format
182180
183181``` text
184- go-wallheven_ <version>_<target-os>_<architecture>.<extension>
182+ go-wallhaven_ <version>_<target-os>_<architecture>.<extension>
185183```
186184
187185The ` <extension> ` is optional. By default, ` version ` is an empty string. A custom
@@ -194,7 +192,7 @@ bash build-script.sh v1.2.1
194192An example of the files generated by the previous command will be;
195193
196194``` sh
197- go-wallheven_v1 .2.1_windows_x86_64.exe
195+ go-wallhaven_v1 .2.1_windows_x86_64.exe
198196```
199197
200198### Setting up Codecov
@@ -217,12 +215,12 @@ after the next run of CI pipeline!
217215
218216### Using Docker
219217
220- To run ` go-wallheven ` in a docker container, read the instructions in
218+ To run ` go-wallhaven ` in a docker container, read the instructions in
221219[ docker section] ( ./docker ) .
222220
223- ### Running ` go-wallheven `
221+ ### Running ` go-wallhaven `
224222
225- To run go-wallheven , use the command
223+ To run go-wallhaven , use the command
226224
227225``` sh
228226make run
@@ -302,41 +300,4 @@ for repositories. [Dependabot][dependabot-link] will implicitly create the
302300` dependencies ` label with the first pull request raised by it.
303301
304302The remaining labels can be created as needed!
305- <br >
306-
307-
308- ## Credits
309-
310- <div align =" center " ><br >
311-
312- ` go-wallheven ` is powered by a template generated using [ ` go-template ` ] [ go-template-link ]
313-
314- [ ![ go-template] ( https://img.shields.io/badge/go--template-black?style=for-the-badge&logo=go )] [ go-template-link ]
315-
316- </div >
317-
318- [ makefile-file ] : ./Makefile
319- [ project-license ] : ./LICENSE
320- [ github-actions ] : ../../actions
321- [ github-releases ] : ../../releases
322- [ precommit-config ] : ./.pre-commit-config.yaml
323- [ gomod-file ] : ../main/go.mod
324- [ github-actions-tests ] : ../../actions/workflows/tests.yml
325- [ dependabot-pulls ] : ../../pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot
326-
327- [ semver-link ] : https://semver.org
328- [ pre-commit ] : https://pre-commit.com
329- [ github-repo ] : https://github.com/new
330- [ gitlab-repo ] : https://gitlab.com/new
331- [ dependabot-link ] : https://dependabot.com
332- [ githooks ] : https://git-scm.com/docs/githooks
333- [ python-install ] : https://www.python.org/downloads
334- [ release-drafter-config ] : ./.github/release-drafter.yml
335- [ makefile-official ] : https://www.gnu.org/software/make
336- [ pip-install ] : https://pip.pypa.io/en/stable/installation
337- [ codecov-docs ] : https://docs.codecov.com/docs#basic-usage
338- [ go-template-link ] : https://github.com/notsatan/go-template
339- [ golangci-install ] : https://golangci-lint.run/usage/install
340- [ cookiecutter-link ] : https://github.com/cookiecutter/cookiecutter
341- [ release-drafter ] : https://github.com/marketplace/actions/release-drafter
342- [ creating-secrets ] : https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository
303+ <br >
0 commit comments