Updated readme

README.md

@@ -10,17 +10,29 @@ An app launcher for Quest implemented in Unity.
 * Support for resizable grid
 * Support for downloading app icons and names, including auto-updating
 
-## Downloading app icons and names (and auto-updating)
-By default, the launcher uses the default app name and icon (from the apk). Sometimes, however, it is desirable to override these - for example, the icon may be the default Oculus icon instead of the actual game icon; or the app name may these do not map to the actual app name and icon in the Oculus Store.
+## Getting Started
 
-To automatically download app names and app icons, go to Settings and chooose "Update Now". To enable auto-updates, go to Settings and enable "Auto-Update". This will automatically download new app names and icons as they become available.
+### Downloading app icons and names / enabling auto-updating
+By default, the launcher uses the built-in app name and icon (from the installed apk). Oculus Store apps, however, sometimes do not contain correct names or icons. To address this, download these assets by going to Settings and choosing "Update Now". To enable auto-updates, enable "Auto-Update". This will automatically download new app names and icons as they become available.
 
-Default repository for app icons and names is [https://github.com/tverona1/QuestAppLauncher_assets]. This can be configured in config.json.
+Default repository for app icons and names is [https://github.com/tverona1/QuestAppLauncher_assets]. This can be configured in config.json (see below).
 
-## Manually overriding app icons and names
+### Settings
+There are various options available in Settings. These are:
+* Automatic Tabs: By default, the launcher will display automatic tabs (Quest, Go/GrearVr and 2D). This setting allows you to specify the position of these tabs (left, top, right or off).
+* Custom Tabs: Custom tabs allow for artibtary categorization (like genre etc). See below for how to configure these. This setting, like the above, allows you to specify the position of these tabs (left, top, right or off).
+* Show 2D: Whether to show 2D apps.
+* Grid Size: How many columns & rows to display.
+* Auto Update & Update Now: Whether to auto-update app icons & names and whether to update these now -- see above.
+* Reset Hidden Apps: This setting un-hides any hidden apps. (To hide an app, highlight the app on the grid and press either the A or Y button on your controller.)
+
+## Advanced Features
+The below sections described advanced / custom features.
+
+### Manually overriding app icons and names
 It is also possible to manually configure app icons and names rather than automatically downloading them. This section describes how.
 
-### Override app names
+#### Override app names
 Create a file called **appnames.txt**. Add a line per app with comma-separated package-id and desired name. Example:  
 appnames.txt:  
 com.mycompany.myapp,My Application  
@@ -30,7 +42,9 @@ Copy this file (appnames.txt) to the following location on your Quest: Android/d
 
 Note: Multiple appnames*.txt files are supported. If multiple files are present, they are applied in sorted order of the filenames. This allows for a single "master" appnames.txt file and then additional files to override it (like appnames_custom.txt).
 
-### Override app icons
+Note: Json-format is also supported. See below.
+
+#### Override app icons
 Create an iconpack.zip file that contains a jpg file per app with the package-id as the filename. Example:  
 com.mycompany.myapp.jpg  
 com.thirdcompany.yetanotherapp.jpg  
@@ -41,19 +55,19 @@ Note: Multiple iconpack*.zip files are supported. If multiple files are present,
 
 Note: Individual jpg files are also supported at the /Android/data/aaa.QuestAppLauncher.app/files path. These override any corresponding jpgs in iconpack*.zip files.
 
-## Configuration
+### Configuration
 The launcher can be customized by creating a **config.json** file and copying it to the following location on your Quest: Android/data/aaa.QuestAppLauncher.App/files.  
 
 The following options are supported:  
-### Categories (tabs)
+#### Categories (tabs)
 By default, the launcher will display automatic tabs (Quest, Go/GrearVr and 2D) and any custom tabs specified in appnames.txt file. These can be overridden with two fields - "autoCategory" and "customCategory". Both fields support the following values:
 
 "off": No not display the categories  
 "top": Display categories on top  
 "left": Display categories on left-side  
 "right": Display categories on right-side  
 
-### Setting Grid Size
+#### Setting Grid Size
 The default grid size is 3x3 cells. The grid size can be customized by specifying grid rows and columns as in the following example:
 
 ```
@@ -65,10 +79,10 @@ The default grid size is 3x3 cells. The grid size can be customized by specifyin
 }
 ```
 
-### Showing / Hiding 2D apps
+#### Showing / Hiding 2D apps
 To show or hide 2D apps, set the "show2D" field to true or false
 
-### Example config.json
+#### Example config.json
 Here's an example config.json:
 
 ```
@@ -90,10 +104,10 @@ Here's an example config.json:
 }
 ```
 
-## Appnames.txt syntax
+### Appnames.txt syntax
 This section describes the syntax for appnames.txt entries
 
-### Custom Categories (Tabs)
+#### Custom Categories (Tabs)
 As described above, the launcher supports custom categories (tabs). This can be specified in the **appnames.txt** file by adding up to two custom categories per entry. The syntax is:  
 packageName,appName[,category1[, category2]]
 
@@ -102,9 +116,15 @@ For example, this will categorize the two entries below in Action and Puzzle tab
 com.mycompany.myapp,My Application,Action  
 com.othercompany.otherapp,Other application,Puzzle  
 
-### Comments
+#### Comments
 Comments can be added to appnames.txt by prepending "#".
 
+### Appnames.json syntax
+Alternatively, json format is also supported for appnames instead of txt file. The syntax for these entries are as follows:
+
+"com.mycompany.myapp":{"name": "My Application", "category": "Action", "category2" : "Puzzle"}
+
+
 ## Source structure:
 - Assets/Scenes/QuestAppLauncher.unity: The main scene
 - Assets/Plugins/Android: Android-specific implementation to retrieve installed apps etc, written in Java