Merge pull request #130 from lohanidamodar/feat-getting-started-section

eldadfux · web-flow · commit 50ce5fd6f217 · 2021-03-05T12:23:29.000+02:00
feat-getting-started-section
diff --git a/src/SDK/SDK.php b/src/SDK/SDK.php
@@ -54,6 +54,7 @@ class SDK
         'shareVia' => '',
         'shareTags' => '',
         'warning' => '',
+        'gettingStarted' => '',
         'readme' => '',
         'changelog' => '',
         'examples' => '',
@@ -186,6 +187,8 @@ public function __construct(Language $language, Spec $spec)
      */
     public function setDefaultHeaders($headers) {
         $this->defaultHeaders = $headers;
+        
+        return $this;
     }
 
     /**
@@ -386,6 +389,17 @@ public function setWarning($message)
         return $this;
     }
 
+    /**
+     * @param $message string
+     * @return $this
+     */
+    public function setGettingStarted($message)
+    {
+        $this->setParam('gettingStarted', $message);
+
+        return $this;
+    }
+
     /**
      * @param $text string
      * @return $this
diff --git a/templates/dart/README.md.twig b/templates/dart/README.md.twig
@@ -31,6 +31,11 @@ You can install packages from the command line:
 pub get {{ language.params.packageName }}
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/deno/README.md.twig b/templates/deno/README.md.twig
@@ -20,6 +20,11 @@
 import * as sdk from "https://deno.land/x/{{ spec.title | caseDash }}/mod.ts";
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/dotnet/README.md.twig b/templates/dotnet/README.md.twig
@@ -33,6 +33,11 @@ dotnet add package {{ spec.title | caseUcfirst }} --version {{ sdk.version }}
 ```
 
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/flutter/README.md.twig b/templates/flutter/README.md.twig
@@ -31,6 +31,11 @@ You can install packages from the command line:
 pub get {{ language.params.packageName }}
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/go/README.md.twig b/templates/go/README.md.twig
@@ -21,6 +21,11 @@ To install using `go get`:
 go get github.com/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/java/README.md.twig b/templates/java/README.md.twig
@@ -34,6 +34,11 @@ You can install packages from the command line:
 mvn install {{ spec.title | caseDash }}
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/node/README.md.twig b/templates/node/README.md.twig
@@ -21,6 +21,11 @@ To install via [NPM](https://www.npmjs.com/):
 npm install {{ language.params.npmPackage }} --save
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/php/README.md.twig b/templates/php/README.md.twig
@@ -21,6 +21,11 @@ To install via [Composer](http://getcomposer.org/):
 composer require {{ language.params.composerVendor }}/{{ language.params.composerPackage }}
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/python/README.md.twig b/templates/python/README.md.twig
@@ -21,6 +21,11 @@ To install via [PyPI](https://pypi.org/):
 pip install {{ language.params.pipPackage }}
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/ruby/README.md.twig b/templates/ruby/README.md.twig
@@ -21,6 +21,11 @@ To install via [Gem](https://rubygems.org/):
 gem install {{ language.params.gemPackage }} --save
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/swift/README.md.twig b/templates/swift/README.md.twig
@@ -21,6 +21,11 @@
     swift run
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## License
 
 Please see the [{{spec.licenseName}} license]({{spec.licenseURL}}) file for more information.
diff --git a/templates/typescript/README.md.twig b/templates/typescript/README.md.twig
@@ -21,6 +21,11 @@ To install via [NPM](https://www.npmjs.com/):
 npm install {{ language.params.npmPackage }} --save
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
diff --git a/templates/web/README.md.twig b/templates/web/README.md.twig
@@ -37,6 +37,11 @@ To install with a CDN (content delivery network) add the following scripts to th
 <script src="https://cdn.jsdelivr.net/npm/{{ language.params.npmPackage }}@{{sdk.version}}"></script>
 ```
 
+{% if sdk.gettingStarted %}
+
+{{ sdk.gettingStarted|raw }}
+{% endif %}
+
 {{ sdk.readme|html }}
 
 ## Contribution
