diff --git a/README.md b/README.md index 1e98c27..b4d2ae1 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,51 @@ -# tomadoro 🍅 -A timer based on the Pomodoro Technique +

Welcome to tomadoro 👋

+

+ Version + + Maintenance + + + License: GPL--3.0--or--later + + + Twitter: franjsco + +

+ +> A timer based on the Pomodoro Technique + +### ✨ [Demo](https://franjsco.github.io/tomadoro/) ![tomadoro screenshot](screenshot.png) -Technologies: -* HTML5 and CSS -* JavaScript -* React.js -* Bootstrap (reactstrap) +## Install -## Demo -Try tomadoro: https://franjsco.github.io/tomadoro/ +```sh +npm install +``` -## License -GPLv3 +## Usage ---- +```sh +npm run start +``` + +## Author + +👤 **franjsco (Francesco Esposito)** + +* Website: https://franjsco.github.io/ +* Twitter: [@franjsco](https://twitter.com/franjsco) +* Github: [@franjsco](https://github.com/franjsco) + +## Show your support + +Give a ⭐️ if this project helped you! + +## 📝 License Photo by Zoltan Tasi on Unsplash +Copyright © 2020 [franjsco (Francesco Esposito)](https://github.com/franjsco).
+This project is [GPL--3.0--or--later](https://github.com/franjsco/tomadoro/blob/master/LICENSE) licensed. -Made with ❤️ by Francesco Esposito ([@franjsco](https://github.com/franjsco)) +*** +_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ \ No newline at end of file