diff --git a/README.md b/README.md index fd202339..3d55e2a5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ openScale ========= + +openScale is an Open Source app for Android to keep a log of your body weight, fat, water and muscle. + +##Features + +- Logs your body weight, fat, water and muscle +- Display all your body data on a chart and table +- Import or export your body data from/into a CSV file +- Connection to a custom made bluetooth scale +- All body data belongs to you (no cloud service) + +##Screens + +![](doc/screens/screen_overview.png) + +![](doc/screens/screen_graph.png) + +![](doc/screens/screen_table.png) + +##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 ist licensed under the GPL v3, see LICENSE file for full notice. + + Copyright (C) 2014 olie.xdev + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see