Updating Readme

IsaacMorris1980 · Aug 24, 2022 · c3806a3 · c3806a3
1 parent f17b227
commit c3806a3
Showing 1 changed file with 23 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,28 @@
 # ShoppingList
 
 
+## Getting Started Running The App - 
+- If you want to connect it to the Kroger API, you'll need to sign up for a Kroger dev account here - https://developer.kroger.com/ 
+- Then go to "Manage" -> "Apps" and create a new app. Once you've done that, create a json file in your project with the following structure - obviously with your values filled in.
+
+        {
+            "ClientId": "",
+            "ClientSecret": "",
+            "RedirectUri": "",
+            "KrogerUrl": "https://api.kroger.com/v1/"
+        }
+
+- Then in KrogerAPIService, you'll just need to point it in the "GetStartupConfig" method to your file. 
+
+- If you don't want to go through all those steps, then you'll need to do some code updates to remove the API calls throughout the app. Unless I decide to go in and make those conditional (which I probably will at some point, in case a user doesn't have internet connection).
+
+- After that, i think you'll just need to do the usual dotnet restore, etc, and you should be good to go? if not let me know in the YT comments, in case I'm forgetting something else. But ultimately, this is just an example app to give you ideas on things you can do in your own apps, and to see how I implemented them. 
+
+
+
 ## Major Features needed for MVP
-- Sorting by aisle (Data from API, sorting by ??? (that might be where the ML comes in))
-- Create new list starting with last week's list
+- ✔ Sorting by aisle (Data from API, sorting by ??? (that might be where the ML comes in))
+- ✔ Create new list starting with last week's list
 
 ## The Build Roadmap
 - ✔ Base app build to give me a UI to test in 
@@ -17,6 +36,6 @@
 - Feature Roadmap starts
 
 ## Feature Roadmap
-- Supporting more stores
-- Skia graphic showing a route through the store? - After Research, not sure store layouts are going to be easily accessible
+- Supporting more stores.
+- Add a 'non-grocery' list option, in case a user just wants to create a regular checklist.
 - As I think of more features, we'll put them here.