Merge pull request #9 from ClydeDz/dev/0.3.0

Add more details to overview readme file, make extension public, and other minor updates.

README.md

@@ -6,7 +6,7 @@
 </div>
 
 # Markdown to API 
-This is an Azure DevOps task that generates JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.  
+This is an Azure DevOps task that generates JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.  
 
 [![Azure DevOps builds](https://img.shields.io/azure-devops/build/clydedsouza/e3d74bc0-b833-41ea-8ec1-0d74115d662a/33?logo=Azure%20DevOps)](https://clydedsouza.visualstudio.com/Markdown%20to%20API/_build) 
 [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/clydedsouza/Markdown%2520to%2520API/33?logo=Azure%20DevOps)](https://clydedsouza.visualstudio.com/Markdown%20to%20API/_build) 
@@ -15,19 +15,25 @@ This is an Azure DevOps task that generates JSON files from Markdown files which
 ![MIT License](https://img.shields.io/static/v1.svg?label=📜%20License&message=MIT&color=informational)     
 
 ## Tasks
-![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks.png)   
 The extension consists of the following two tasks. You need to add these tasks in this order. 
 1. Install Markdown to API Dependencies   
-2. Markdown to API
-
+2. Markdown to API   
+
+![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks.png)   
+
 ### Install Markdown to API Dependencies   
+Add this task before the `Markdown to API` task so all the required dependencies can be installed and ready for use. No inputs required.  
+
 ![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks-install.png)   
-Add this task before the `Markdown to API` task so all the required dependencies can be installed and ready for use. No inputs required.    
+
 
 ### Markdown to API     
+Add this task to process your Markdown files into JSON files. This task requires one user input - the location of the config file including the name of the file itself. So, in the screenshot below, the JSON config file was located in the `Example1` folder and was named `markdown-to-api.json` hence that's the value that was entered in the field. Remember, you can name the config anything you like, and as long as your config file follows the schema (details below), you should be sweet!  
+
 ![tasks](https://raw.githubusercontent.com/ClydeDz/markdown-to-api/main/images/markdowntoapitasks-process.png)   
-Add this task to process your Markdown files into JSON files. This task requires one user input - the location of the config file including the name of the file itself. So, in the screenshot above, the JSON config file was located in the `Example1` folder and was named `markdown-to-api.json` hence that's the value that was entered in the field. Remember, you can name the config anything you like, and as long as your config file follows the schema (details below), you should be sweet!  
 
+You can organise your Markdown files as you like. You can also add FrontMatter to each Markdown file. This task will convert each Markdown file into a JSON file and maintain the same folder structure in the output directory. It will also generate a summary JSON file which will contain the details of all Markdown files in a single JSON file.  
+
 #### Schema of the config file
 The following JSON properties are expected in the config file.  
 
@@ -44,7 +50,7 @@ The following JSON properties are expected in the config file.
 Find more information on the usage and different scenarios in [this GitHub repository](https://github.com/ClydeDz/markdown-to-api-examples).   
 
 ## Support  
-The easiest way is to [create an issue](https://github.com/ClydeDz/markdown-to-api/issues/new/choose) in the GitHub repository.  
+The easiest way is to [create an issue](https://github.com/ClydeDz/markdown-to-api/issues/new/choose) on GitHub.  
 
 ## Credits
 This extension is developed by [Clyde D'Souza](https://twitter.com/clydedz).    

src/install/index.js

@@ -12,4 +12,5 @@ function run() {
     }
 }
 
+// Starts here
 run();

src/install/task.json

@@ -9,8 +9,8 @@
     "author": "Clyde D'Souza",
     "version": {
         "Major": 0,
-        "Minor": 2,
-        "Patch": 1
+        "Minor": 3,
+        "Patch": 0
     },
     "instanceNameFormat": "Install Markdown to API Dependencies",
     "execution": {

src/package.json

@@ -1,7 +1,7 @@
 {
   "name": "markdown-to-api",
   "version": "1.0.0",
-  "description": "Generate JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.",
+  "description": "Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.",
   "main": "index.js",
   "scripts": {
     "test": "mocha tests/*.test.js --reporter mocha-junit-reporter --timeout 10000 --exit",

src/process/index.js

@@ -58,4 +58,5 @@ function run() {
     }
 }
 
+// Starts here
 run();

src/process/task.json

@@ -3,14 +3,14 @@
     "id": "5a00c9ee-cdb8-4bdb-a3af-97137d8355ba",
     "name": "markdown-to-api",
     "friendlyName": "Markdown to API",
-    "description": "Generate JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.",
+    "description": "Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.",
     "helpMarkDown": "[More information](https://github.com/ClydeDz/markdown-to-api#markdown-to-api-1)",
     "category": "Utility",
     "author": "Clyde D'Souza",
     "version": {
         "Major": 0,
-        "Minor": 2,
-        "Patch": 1
+        "Minor": 3,
+        "Patch": 0
     },
     "instanceNameFormat": "Execute Markdown to API",
     "inputs": [ 

vss-extension.json

@@ -2,17 +2,15 @@
     "manifestVersion": 1,
     "id": "markdown-to-api",
     "name": "Markdown to API",
-    "version": "0.2.1",
+    "version": "0.3.0",
     "publisher": "clydedsouza",
-    "galleryFlags": [
-        "Preview"
-    ],
+    "public": true,
     "targets": [
         {
             "id": "Microsoft.VisualStudio.Services"
         }
     ],    
-    "description": "Generate JSON files from Markdown files which can then be consumed by your frontend app. Basically, a static API generator.",
+    "description": "Generate JSON files from Markdown files which can then be consumed by your front-end app. Basically, a static API generator.",
     "categories": [
         "Azure Pipelines"
     ],