diff --git a/README.md b/README.md index a38699b..2206103 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -# Templatizer - [![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md) [![GitHub Release](https://img.shields.io/github/v/release/wesovilabs/templatizer)](https://github.com/wesovilabs/templatizer/releases) [![Go Reference](https://pkg.go.dev/badge/github.com/wesovilabs/templatizer.svg)](https://pkg.go.dev/github.com/wesovilabs/templatizer) @@ -8,19 +6,16 @@ [![Build Status](https://img.shields.io/github/workflow/status/wesovilabs/templatizer/build)](https://github.com/wesovilabs/templatizer/actions?query=workflow%3Abuild+branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/wesovilabs/templatizer)](https://goreportcard.com/report/github.com/wesovilabs/templatizer) [![Codecov](https://codecov.io/gh/wesovilabs/templatizer/branch/main/graph/badge.svg)](https://codecov.io/gh/wesovilabs/templatizer) +--- +# Templatizer - +Template is created to empower the way to take advantage of template repositories. It's known that Github (nor Gitlab) doesn't provide us a handy way to take advantage of the Template repositories. When we start from a Template we usually need to do a lof of manual replacement tasks. ## Getting started - -The intention of Templatizer is to empower the way to take advantage of template repositories. It's known that Github (nor Gitlab) doesn't provide us a handy way to take advantage of the Template repositories. When we start from a Template we usually need to do a lof of manual replacement tasks. - - - -### Intallation +### Installation ### -## Contibuting +## Contributing Contributions are welcome, but before doing it I hardly recommend you to have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) and the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). @@ -32,5 +27,3 @@ In other case you would need to setup manually the following tools: - [Hadolint]: Visit the [official repository](https://github.com/hadolint/hadolint) - [pre-commit]: Visit the [official site])(https://pre-commit.com/). - -Additionaly you could want to install [gorelease](https://goreleaser.com/).