diff --git a/README.md b/README.md index e69de29..4b8c0c4 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,62 @@ +# ![barklarm_normal](https://user-images.githubusercontent.com/3071208/167244374-da18da7a-f52a-4f25-aa9e-c71476647c9c.png) + +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/barklarm/barklarm-app/Build%20%26%20Publish) +![GitHub all releases](https://img.shields.io/github/downloads/barklarm/barklarm-app/total) +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +[![Maintainability](https://api.codeclimate.com/v1/badges/2722ae6ccb495529d393/maintainability)](https://codeclimate.com/github/barklarm/barklarm-app/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/2722ae6ccb495529d393/test_coverage)](https://codeclimate.com/github/barklarm/barklarm-app/test_coverage) +![GitHub](https://img.shields.io/github/license/barklarm/barklarm-app) +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/kanekotic/endomondo-unofficial-api/graphs/commit-activity) +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/kanekotic/) + +## Support Us + +[![Product Hunt](https://img.shields.io/badge/Product%20Hunt-like-blue?style=for-the-badge)](https://www.producthunt.com/posts/barklarm) +[![AlternativeTo](https://img.shields.io/badge/alternativeto.net-like-blue?style=for-the-badge)](https://alternativeto.net/software/barklarm/about/) + +## Join The Conversation + +[![Slack](https://img.shields.io/badge/Slack-like-blue?style=for-the-badge)](https://join.slack.com/t/barklarm/shared_invite/zt-1hyocikcy-kMxfq8jsCsSSmuGVkeFrBA) + +## Motivation + +There is currently no open source radiator application that is multiplatform and that can be extensible to support diferent platforms (ex. Github actions) that dont support cctray xml format. + +Barklarm looks forward to become this one go to application. + +## Getting Started + +Jus follow this simple steps: +- [downloading barklarm](https://github.com/barklarm/barklarm-app/releases) +- install +- Run + +With this next 120 seconds video you will be able to start by yourself. + +[intro.webm](https://user-images.githubusercontent.com/3071208/189301010-0f467bfa-b5e7-4d7b-99fa-d666fbd290b1.webm) + +Further documentation on this project can be found [here](https://www.barklarm.com/docs/intro) + + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + +
Dimitar Apostolov 💻 |
+ Ezinne Anne Emilia 📖 |
+