From 1beb3cdf0fed9402fa5a8041a5a75a14f79dc6e5 Mon Sep 17 00:00:00 2001 From: Piotr Rogowski Date: Sun, 15 Aug 2021 13:57:37 +0200 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b1e1eb6..0b43bd3 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,37 @@ [![Netlify Status](https://api.netlify.com/api/v1/badges/83204fc5-98b8-483c-ac69-acaa656ba9ee/deploy-status)](https://app.netlify.com/sites/speedytuner/deploys) ![master](https://github.com/speedy-tuner/speedy-tuner-cloud/actions/workflows/lint.js.yml/badge.svg?branch=master) -Share your Speeduino tune and logs. +Share your [Speeduino](https://speeduino.com/) tune and logs. ## [https://speedytuner.cloud](https://speedytuner.cloud) ![Screenshot](https://speedytuner.cloud/img/screen.png) +## Project main goals + +- ๐Ÿš€ always free and open source (FOSS) +- ๐Ÿ’ป Cloud based web app with CDN +- ๐Ÿ”ฅ `60 FPS` animations and fast load times +- ๐Ÿ‘ good user experience + - ๐Ÿ’Ž intuitive, modern and responsive UI + - ๐Ÿ‘ถ easy for newcomers with tips, tools and simple diagnostics + - ๐Ÿ“ฑ touch screen friendly + +## ECU firmware + +- Documentation: [wiki.speeduino.com](https://wiki.speeduino.com/) +- Source code: [noisymime/speeduino](https://github.com/noisymime/speeduino) + +## Contributing ๐Ÿค + +There are many ways in which you can participate in the project and every bit of help is greatly appreciated. + +- ๐Ÿ‘‹ Say Hi and start a conversation over at [Discussions](https://github.com/karniv00l/speedy-tuner/discussions) +- ๐Ÿž [Submit bugs and feature requests](https://github.com/karniv00l/speedy-tuner/issues) +- ๐Ÿงช Test on different platforms, hardware and Speeduino firmware +- ๐Ÿ‘“ Review source code +- โŒจ๏ธ Write tests and refactor code according to best practices + ## Development Recommended dev environment: