diff --git a/README.md b/README.md index 753a387..ed451ca 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A brief description of your project, what it is used for. -## Installing / Getting started +## :construction_worker: Installing / Getting started A quick introduction of the minimal setup you need to get a hello world up & running. @@ -19,18 +19,34 @@ commands here Here you should say what actually happens when you execute the code above. -## Versioning +## :trophy: Versioning I use [SemVer](http://semver.org/) for versioning. For the versions available, see the [Tags](../../../tags). -## Configuration +## 📥 Configuration example_how_it_works -## Issue feedback +## :bug: Issue feedback -You can get feedback on issues you encounter via [Issues](../../../issues) +Feel free to **file a new issue** with a respective title and description on the the [repository](../../../issues). If you already found a solution to your problem, [**i would love to review your pull request**](../../../pulls)! -## Licensing -For more information, please refer to the [LICENSE](LICENSE) file. \ No newline at end of file +## :tada: Contributing + +First of all, thank you for being interested in helping out, your time is always appreciated in every way. :100: + +Here's some tips: + +* Check the [issues page](../../../issues) for already opened issues (or maybe even closed ones) that might already address your question/bug/feature request. +* Feature requests are welcomed! Provide some details on why it would be helpful for you and others, explain how you're using bull-board and if possible even some screenshots if you are willing to mock something! + +Check out the [contributing](./CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing. + +## :closed_book: Licensing + +Released in 2021 :closed_book: License + +For more information, please refer to the [LICENSE](LICENSE) file. + +Give a ⭐️ if this project helped you! \ No newline at end of file