diff --git a/README.md b/README.md index 8e114755..5d03bcfb 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,36 @@ openScale [![Build Status](https://travis-ci.org/oliexdev/openScale.svg?branch=m https://travis-ci.org/oliexdev/openScale) ========= -openScale is an open source app to keep a log of your weight, body fat, water percentage and muscle percentage. +openScale is an open source app which support various Bluetooth scales to keep log of your body metrics. Get it on F-Droid Get it on Google Play -Install [openScale-dev-build.apk](https://github.com/oliexdev/openScale/blob/master/openScale-dev-build.apk) to get the latest development build generated by [Travis CI](https://travis-ci.org/). But be aware that this version may contain bugs and you don't get any automatically updates. +Install [openScale-dev-build.apk](https://github.com/oliexdev/openScale/releases) to get the latest development build generated by [Travis CI](https://travis-ci.org/). But be aware that this version may contain bugs and you don't get any automatically updates. # Features -- Logs your weight, body fat, water percentage and muscle percentage +- Logs your body metrics (weigt, body fat, body water, muscl percentage, lean body mass, bone mass, BMI, BMR, waist/hip circumference, waist-hip ratio, waist-to-height ratio) +- Keep track of your diet process - Display all your data on a chart and table - Import or export your data from/into a CSV file +- Estimates body metrics (body fat, body water and lean body mass) based on scientic publications - Support for multiple users -- Support for Bluetooth Xiaomi Mi Scale, Sanitas SBF70, Medisana BS444, Digoo DG-S038H, Yunmai Mini (basic support) -- Connection to a custom made bluetooth scale (see [openScale wiki](https://github.com/oliexdev/openScale/wiki) for more information) +- Partially or full support for custom made Bluetooth scale, Xiaomi Mi scale v1, Sanitas SBF70, Medisana BS444, Digoo DG-S038H, Yunmai Mini, Excelvan CF369BLE, Yunmai SE, MGB, Xiaomi Mi scale v2 (see [openScale wiki](https://github.com/oliexdev/openScale/wiki/Supported-scales-in-openScale) for details) - All data belongs to you (no cloud service) +# Supported Bluetooth scales + +Please see in the [openScale wiki](https://github.com/oliexdev/openScale/wiki/) which Bluetooth scales are full or parially supported. + +# Contributing + +If you found a bug, have an idea how to improve the openScale app or have a question, please create new issue or comment existing one. If you would like to contribute code, fork the repository and send a pull request. + +If you want to help to support your Bluetooth scale please see [here](https://github.com/oliexdev/openScale/wiki/How-to-reverse-engineer-a-Blueeoth-4.x-scale) for further information. + # Screens @@ -61,10 +72,6 @@ Install [openScale-dev-build.apk](https://github.com/oliexdev/openScale/blob/mas
-# Contributing - -If you found a bug, have an idea how to improve the openScale app or have a question, please create new issue or comment existing one. If you would like to contribute code, fork the repository and send a pull request. - # License openScale is licensed under the GPL v3, see LICENSE file for full notice.