Complete README.md with license, changelog, code of conduct etc...

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+- Nothing so far
+
+## [v0.1.0] - 2023-03-07
+- Initial release
+
+[Unreleased]: https://github.com/fgrosse/kafkactl/compare/v0.1.0...HEAD
+[v0.1.0]: https://github.com/fgrosse/kafkactl/releases/tag/v0.1.0
+

CONTRIBUTING.md

@@ -0,0 +1,95 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish
+to make via an issue on GitHub *before* making a change.
+
+Please note we have a code of conduct. Please follow it in all your interactions
+with the project.
+
+## Pull Request Process
+
+0. Everything should start with an issue: ["Talk, then code"][talk-code]
+1. Cover all your changes with unit tests, when unsure how, ask for help
+2. Run all unit tests with the race detector on
+3. Run the linters locally via `golangci-lint run`
+4. Update the [CHANGELOG.md](CHANGELOG.md) with the changes you made (in the "Unreleased" section)
+5. Consider updating the [README.md](README.md) with details of your changes.
+   When in doubt, lets discuss the need together in the corresponding GitHub issue.
+
+## Code of Conduct
+
+We follow the **Gopher Code of Conduct** as described at https://golang.org/conduct `\ʕ◔ϖ◔ʔ/`
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Conflict Resolution
+
+We do not believe that all conflict is bad; healthy debate and disagreement
+often yield positive results. However, it is never okay to be disrespectful or
+to engage in behavior that violates the project’s code of conduct.
+
+If you see someone violating the code of conduct, you are encouraged to address
+the behavior directly with those involved. Many issues can be resolved quickly
+and easily, and this gives people more control over the outcome of their dispute.
+If you are unable to resolve the matter for any reason, or if the behavior is
+threatening or harassing, report it. We are dedicated to providing an environment
+where participants feel welcome and safe.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[talk-code]: https://dave.cheney.net/2019/02/18/talk-then-code
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2023, Friedrich Große
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -142,8 +142,48 @@ pick the tool that serves your use case best:
 * https://github.com/deviceinsight/kafkactl
 * https://github.com/jbvmio/kafkactl
 
+## Built With
+
+* [sarama](https://github.com/Shopify/sarama) - a Go library for Apache Kafka
+* [cobra](https://github.com/spf13/cobra) - a library to build powerful CLI applications
+* [viper](https://github.com/spf13/viper) - configuration with fangs
+* [protoreflect](https://github.com/jhump/protoreflect) - reflection for Go Protocol Buffers
+* [testify](https://github.com/stretchr/testify) - A simple unit test library
+* _[and more][built-with]_
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of
+conduct and on the process for submitting pull requests to this repository.
+
+## Versioning
+
+All significant (e.g. breaking) changes are documented in the [CHANGELOG.md](CHANGELOG.md).
+
+After the v1.0 release we plan to use [SemVer](http://semver.org/) for versioning.
+For the versions available, see the [releases page][releases].
+
+## Authors
+
+- **Friedrich Große** - *Initial work* - [fgrosse](https://github.com/fgrosse)
+- Various folks at [Fraugster](https://github.com/fraugster)
+  - **Julius Bachnick** - [juliusbachnick](https://github.com/juliusbachnick)
+  - **Andreas Krennmair** - [akrennmair](https://github.com/akrennmair)
+  - **Stefan Warman** - [warmans](https://github.com/warmans)
+  - **Stefan Koshiw** - [panamafrancis](https://github.com/panamafrancis)
+  - **Oleg Prozorov** - [oleg](https://github.com/oleg)
+  - _and more..._
+
+See also the list of [contributors][contributors] who participated in this project.
+
+## License
+
+This project is licensed under the BSD-3-Clause License - see the [LICENSE](LICENSE) file for details.
+
 [kafka]: https://kafka.apache.org/
 [protobuf]: https://protobuf.dev/
 [go]: https://go.dev/
 [releases]: https://github.com/fgrosse/kafkactl/releases
 [fraugster]: https://github.com/fraugster
+[contributors]: https://github.com/fgrosse/kafkactl/contributors
+[built-with]: go.mod