diff --git a/README.md b/README.md index e0b3f9b0e..c70dcfea1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# evcc +# evcc 🚘☀️ [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/evcc-io/evcc) [![Build Status](https://github.com/evcc-io/evcc/workflows/Build/badge.svg)](https://github.com/evcc-io/evcc/actions?query=workflow%3ABuild) @@ -7,8 +7,9 @@ [![Pulls from Docker Hub](https://img.shields.io/docker/pulls/andig/evcc.svg)](https://hub.docker.com/r/andig/evcc) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=48YVXXA7BDNC2) -EVCC is an extensible EV Charge Controller with PV integration implemented in [Go][2]. Featured in [PV magazine](https://www.pv-magazine.de/2021/01/15/selbst-ist-der-groeoenlandhof-wallbox-ladesteuerung-selbst-gebaut/). +Evcc is an extensible EV Charge Controller with PV integration implemented in [Go][2]. Featured in [PV magazine](https://www.pv-magazine.de/2021/01/15/selbst-ist-der-groeoenlandhof-wallbox-ladesteuerung-selbst-gebaut/). +![Screenshot](docs/screenshot.png) ## Features @@ -26,11 +27,9 @@ EVCC is an extensible EV Charge Controller with PV integration implemented in [G - granular charge power control down to mA steps with supported chargers (labeled by e.g. smartWB als [OLC](https://board.evse-wifi.de/viewtopic.php?f=16&t=187)) - REST and MQTT [APIs](https://docs.evcc.io/docs/reference/api) for integration with home automation systems (e.g. [HomeAssistant](https://github.com/evcc-io/evcc-hassio-addon)) -![Screenshot](docs/screenshot.png) +## Getting Started -## Documentation - -Documentation is available in german language at [https://docs.evcc.io/](https://docs.evcc.io/) +You'll find everything you need in our [documentation](https://docs.evcc.io/) (German). ## Build @@ -42,10 +41,10 @@ make ## Sponsorship -EVCC believes in open source software. We're committed to provide best in class EV charging experience. -Maintaining EVCC consumes time and effort. With the vast amount of different devices to support, we depend on community and vendor support to keep EVCC alive. +Evcc believes in open source software. We're committed to provide best in class EV charging experience. +Maintaining evcc consumes time and effort. With the vast amount of different devices to support, we depend on community and vendor support to keep EVCC alive. -While EVCC is open source, we would also like to encourage vendors to provide open source hardware devices, public documentation and support open source projects like hours that provide additional value to otherwised closed hardware. Where this is not the case, EVCC requires "sponsor token" to finance ongoing development and support of evcc. +While evcc is open source, we would also like to encourage vendors to provide open source hardware devices, public documentation and support open source projects like hours that provide additional value to otherwised closed hardware. Where this is not the case, EVCC requires "sponsor token" to finance ongoing development and support of evcc. The personal sponsor token requires a [Github Sponsorship](https://github.com/sponsors/andig) and can be requested at [cloud.evcc.io](https://cloud.evcc.io/). A sponsor token is valid for one year and can be renewed any time with active sponsorship. @@ -53,18 +52,18 @@ The personal sponsor token requires a [Github Sponsorship](https://github.com/sp -EVCC is heavily inspired by [OpenWB][1]. However, in 2019, I found OpenWB's architecture slightly intimidating with everything basically global state and heavily relying on shell scripting. On the other side, especially the scripting aspect is one that contributes to [OpenWB's][1] flexibility. +Evcc is heavily inspired by [OpenWB][1]. However, in 2019, I found OpenWB's architecture slightly intimidating with everything basically global state and heavily relying on shell scripting. On the other side, especially the scripting aspect is one that contributes to OpenWB's flexibility. -Hence, for a simplified and stricter implementation of an EV charge controller, the design goals for EVCC were: +Hence, for a simplified and stricter implementation of an EV charge controller, the design goals for evcc were: - typed language with ability for systematic testing - achieved by using [Go][2] - structured configuration - supports YAML-based [config file](evcc.dist.yaml) -- avoidance of feature bloat, simple and clean UI - utilizes [Bootstrap][4] -- containerized operation beyond Raspberry Pi - provide multi-arch [Docker Image][5] +- avoidance of feature bloat, simple and clean UI - utilizes [Vue.js][4] and [Bootstrap][5] +- containerized operation beyond Raspberry Pi - provide multi-arch [Docker Image][6] [1]: https://github.com/snaptec/openWB [2]: https://golang.org [3]: https://nodejs.org/ -[4]: https://getbootstrap.org -[5]: https://hub.docker.com/repository/docker/andig/evcc -[6]: https://github.com/volkszaehler/mbmd +[4]: https://vuejs.org +[5]: https://getbootstrap.org +[6]: https://hub.docker.com/repository/docker/andig/evcc