diff --git a/README.md b/README.md new file mode 100644 index 0000000..907c7e1 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# SmartPETFeederMobile +A mobile app for SmartPET Feeder. About how to setup a SmartPET Feeder, please refer to SmartPET-Feeder repository. +## Installation: +### Requirements ++ An Android phone. Network connection is needed. +### Install ++ You need to download .apk file from Release, or build from source code. + +## Usage +### Quick start: ++ This mobile app is user-friendly. You can use it directly by following instructions. + +## Contributing: +You can open an Issue or a Pull request at all time. If I haven't make a reply in one day, please notice me by email to smart_pet@126.com. + +## License: +This project was licensed under GPL v3.0 license. For more detail, please look at the LICENSE file.