Merge pull request #1412 from template-tools/readme-api

Sync API into README
template-tools · Jun 30, 2021 · a18bd26 · a18bd26
2 parents 7dc28c8 + 5a2b80a
commit a18bd26
Showing 1 changed file with 76 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -80,72 +80,87 @@ Merges contents from template branch into destination branch handling some speci
 ### Table of Contents
 
 *   [Delete](#delete)
-*   [normalizeTemplateSources](#normalizetemplatesources)
-    *   [Parameters](#parameters)
-*   [jspath](#jspath)
-    *   [Parameters](#parameters-1)
-*   [actions2message](#actions2message)
-    *   [Parameters](#parameters-2)
-*   [actions2messages](#actions2messages)
-    *   [Parameters](#parameters-3)
-*   [Merger](#merger)
-    *   [properties](#properties)
-        *   [Parameters](#parameters-4)
-    *   [commits](#commits)
-        *   [Parameters](#parameters-5)
 *   [MergeLineSet](#mergelineset)
 *   [sortedKeys](#sortedkeys)
 *   [Package](#package)
-    *   [properties](#properties-1)
-        *   [Parameters](#parameters-6)
+    *   [properties](#properties)
+        *   [Parameters](#parameters)
 *   [Readme](#readme)
 *   [ReplaceIfEmpty](#replaceifempty)
 *   [Replace](#replace)
 *   [Skip](#skip)
+*   [Merger](#merger)
+    *   [properties](#properties-1)
+        *   [Parameters](#parameters-1)
+    *   [commits](#commits)
+        *   [Parameters](#parameters-2)
+*   [normalizeTemplateSources](#normalizetemplatesources)
+    *   [Parameters](#parameters-3)
+*   [jspath](#jspath)
+    *   [Parameters](#parameters-4)
+*   [actions2message](#actions2message)
+    *   [Parameters](#parameters-5)
+*   [actions2messages](#actions2messages)
+    *   [Parameters](#parameters-6)
 
 ## Delete
 
 **Extends Merger**
 
 Delete entry.
 
-## normalizeTemplateSources
+## MergeLineSet
 
-Remove duplicate sources.
-Sources staring with '-' will be removed
+**Extends Merger**
 
-### Parameters
+## sortedKeys
 
-*   `sources` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
-*   `remove` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**  (optional, default `[]`)
+order in which json keys are written
 
-Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** normalized sources
+## Package
 
-## jspath
+**Extends Merger**
 
-### Parameters
+Merger for package.json
 
-*   `object`  
-*   `path`  
-*   `cb`  
+### properties
 
-## actions2message
+Deliver some key properties.
 
-### Parameters
+*   name
+*   version
+*   description
+*   main
 
-*   `actions`  
-*   `prefix`  
-*   `name`  
+#### Parameters
 
-Returns **any** actions as one string lines ordered by scope
+*   `entry` **ContentEntry** 
 
-## actions2messages
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
-### Parameters
+## Readme
 
-*   `actions`  
-*   `prefix`  
-*   `name`  
+**Extends Merger**
+
+injects badges into README.md
+
+## ReplaceIfEmpty
+
+**Extends Merger**
+
+Overwrites none existing entries from template.
+
+## Replace
+
+**Extends Merger**
+
+Replace file from template (always)
+
+## Skip
+
+**Extends Merger**
+
+Does not generate destination entry
 
 ## Merger
 
@@ -172,58 +187,43 @@ Generate commits as result of merging two entries.
 *   `sourceEntry`  
 *   `options`  
 
-## MergeLineSet
-
-**Extends Merger**
-
-## sortedKeys
-
-order in which json keys are written
-
-## Package
-
-**Extends Merger**
-
-Merger for package.json
-
-### properties
-
-Deliver some key properties.
-
-*   name
-*   version
-*   description
-*   main
-
-#### Parameters
+## normalizeTemplateSources
 
-*   `entry` **ContentEntry** 
+Remove duplicate sources.
+Sources staring with '-' will be removed
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+### Parameters
 
-## Readme
+*   `sources` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
+*   `remove` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**  (optional, default `[]`)
 
-**Extends Merger**
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** normalized sources
 
-injects badges into README.md
+## jspath
 
-## ReplaceIfEmpty
+### Parameters
 
-**Extends Merger**
+*   `object`  
+*   `path`  
+*   `cb`  
 
-Overwrites none existing entries from template.
+## actions2message
 
-## Replace
+### Parameters
 
-**Extends Merger**
+*   `actions`  
+*   `prefix`  
+*   `name`  
 
-Replace file from template (always)
+Returns **any** actions as one string lines ordered by scope
 
-## Skip
+## actions2messages
 
-**Extends Merger**
+### Parameters
 
-Does not generate destination entry
+*   `actions`  
+*   `prefix`  
+*   `name`  
 
 # install