[cordova-app-hello-world] branch master updated: doc(README): fix markdown lint warnings & add npm badge (#64)

[er...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

erisu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-app-hello-world.git


The following commit(s) were added to refs/heads/master by this push:
     new 887d4b9  doc(README): fix markdown lint warnings & add npm badge (#64)
887d4b9 is described below

commit 887d4b9258dec2badb4a80b1efa0a1b17733cb50
Author: エリス <er...@users.noreply.github.com>
AuthorDate: Wed Apr 1 23:59:34 2020 +0900

    doc(README): fix markdown lint warnings & add npm badge (#64)
---
 README.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index e2639d3..ae6940e 100644
--- a/README.md
+++ b/README.md
@@ -21,12 +21,16 @@
 
 # Apache Cordova Hello World Application
 
+[![NPM](https://nodei.co/npm/cordova-app-hello-world.png)](https://nodei.co/npm/cordova-app-hello-world/)
+
 A simple Hello World application that serves two purposes:
+
 - It is used as the default app template when creating new projects
 - It is a reference for building and publishing custom Cordova Templates
 
 ## Structure of your template
-```
+
+```text
 template_package
 ├── package.json (for your template package to be published on npm)
 ├── index.js
@@ -35,13 +39,17 @@ template_package
     ├── config.xml
     └── (files and folders that make up the template)
 ```
+
 ### Outside of `template_src`
-All files outside of `template_src` are used to define parameters about the template. These files are not copied over at creation, so feel free to add a README or any other files outside  of template_src.
+
+All files outside of `template_src` are used to define parameters about the template. These files are not copied over at creation, so feel free to add a README or any other files outside of `template_src`.
 
 #### index.js
-`index.js` points to where the template exists. You'll see that index.js usually looks like:
+
+`index.js` points to where the template exists. You'll see that `index.js` usually looks like:
+
 ```javascript
-var path = require('path');
+const path = require('path');
 
 module.exports = {
     dirname : path.join(__dirname, 'template_src')
@@ -49,7 +57,9 @@ module.exports = {
 ```
 
 #### package.json
-This `package.json` holds *information about the template itself* like its name, version etc. All templates should contain the keyword `"cordova:template"` so that the template is searchable on npm. For example:
+
+This `package.json` holds *information about the template itself* like its `name`, `version` etc. All templates should contain the keyword `"cordova:template"` so that the template is searchable on npm. For example:
+
 ```json
 {
     "name": "cordova-example-template",
@@ -62,6 +72,7 @@ This `package.json` holds *information about the template itself* like its name,
 ```
 
 ### Inside of `template_src`
+
 All files inside of `template_src` compose the template from which a user would desire in order to create their project. Everything in this folder is copied over to the created project.
 
 The package.json in `template_src` should be filled with information that describes *the project that would be created from the template*.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org