Update README.md

This commit is contained in:
Piotr Rogowski 2021-08-15 13:57:37 +02:00 committed by GitHub
parent 4cebbde389
commit 1beb3cdf0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 1 deletions

View File

@ -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: