diff --git a/README.md b/README.md index a6c12794..0758c871 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Mobile app for wger Workout Manager -wger is a free, open source flutter application that manages and tracks/logs -your exercises and personal workouts, weight and diet plans. This is the mobile +wger is a free, open-source flutter application that manages and tracks/logs +your exercises and personal workouts, weight, and diet plans. This is the mobile app written with Flutter, it talks via REST with the main server. If you want to contribute, hop on the Discord server and say hi! @@ -26,13 +26,13 @@ If you want to contribute, hop on the Discord server and say hi! ## Development ### 1 -Install the wger server, the easiest way is starting the development docker-compose: +Install the wger server, the easiest way is to start the development docker-compose: Alternatively, you can use one of our test servers, just ask us for access. ### 2 -Install Flutter, all its dependencies and create a new virtual device: +Install Flutter, and all its dependencies, and create a new virtual device: . The app currently uses flutter 2.10 @@ -45,12 +45,12 @@ WGER_API_KEY=123456 ``` To just run/develop the app it only needs to have any value for WGER_API_KEY, but -you need a correct value if you want to register via the app. For this you need -to allow (a probably dedicated) user on the wger server to register users in its +you need a correct value if you want to register via the app. For this, you need +to allow (a probably dedicated) user on the wger server to register users on its behalf. For this, generate an API KEY by visiting -on your local instance and then run ``python3 manage.py add-user-rest theusername`` +on your local instance and then run ``python3 manage.py add-user-rest the username`` -You can later list all the registered users with: ``python3 manage.py list-users-api`` +You can later list all the registered users with: ``python3 manage.py list-users-API`` [