Skip to content

Commit af26a6b

Browse files
authored
Merge pull request #146 from appwrite/feat-new-links
Added discord and twitter badges
2 parents 3dc5325 + 69baff0 commit af26a6b

File tree

16 files changed

+166
-30
lines changed

16 files changed

+166
-30
lines changed

example.php

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ function getSSLPage($url) {
6262
->setChangelog('**CHANGELOG**')
6363
->setGitUserName('repoowner')
6464
->setGitRepoName('reponame')
65+
->setTwitter('appwrite_io')
66+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
6567
->setDefaultHeaders([
6668
'X-Appwrite-Response-Format' => '0.7.0',
6769
])
@@ -85,6 +87,8 @@ function getSSLPage($url) {
8587
->setReadme("## Getting Started")
8688
->setGitUserName('repoowner')
8789
->setGitRepoName('reponame')
90+
->setTwitter('appwrite_io')
91+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
8892
->setDefaultHeaders([
8993
'X-Appwrite-Response-Format' => '0.7.0',
9094
])
@@ -107,6 +111,8 @@ function getSSLPage($url) {
107111
->setChangelog('**CHANGELOG**')
108112
->setGitUserName('repoowner')
109113
->setGitRepoName('reponame')
114+
->setTwitter('appwrite_io')
115+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
110116
->setDefaultHeaders([
111117
'X-Appwrite-Response-Format' => '0.7.0',
112118
])
@@ -129,6 +135,8 @@ function getSSLPage($url) {
129135
->setChangelog('**CHANGELOG**')
130136
->setGitUserName('repoowner')
131137
->setGitRepoName('reponame')
138+
->setTwitter('appwrite_io')
139+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
132140
->setDefaultHeaders([
133141
'X-Appwrite-Response-Format' => '0.7.0',
134142
])
@@ -150,6 +158,8 @@ function getSSLPage($url) {
150158
->setChangelog('**CHANGELOG**')
151159
->setGitUserName('repoowner')
152160
->setGitRepoName('reponame')
161+
->setTwitter('appwrite_io')
162+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
153163
->setDefaultHeaders([
154164
'X-Appwrite-Response-Format' => '0.7.0',
155165
])
@@ -171,6 +181,8 @@ function getSSLPage($url) {
171181
->setChangelog('**CHANGELOG**')
172182
->setGitUserName('repoowner')
173183
->setGitRepoName('reponame')
184+
->setTwitter('appwrite_io')
185+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
174186
->setDefaultHeaders([
175187
'X-Appwrite-Response-Format' => '0.7.0',
176188
])
@@ -192,6 +204,8 @@ function getSSLPage($url) {
192204
->setChangelog('**CHANGELOG**')
193205
->setGitUserName('repoowner')
194206
->setGitRepoName('reponame')
207+
->setTwitter('appwrite_io')
208+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
195209
->setDefaultHeaders([
196210
'X-Appwrite-Response-Format' => '0.7.0',
197211
])
@@ -218,6 +232,8 @@ function getSSLPage($url) {
218232
->setVersion('0.0.1')
219233
->setGitUserName('repoowner')
220234
->setGitRepoName('reponame')
235+
->setTwitter('appwrite_io')
236+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
221237
->setDefaultHeaders([
222238
'X-Appwrite-Response-Format' => '0.7.0',
223239
])
@@ -243,6 +259,8 @@ function getSSLPage($url) {
243259
->setVersion('0.0.1')
244260
->setGitUserName('repoowner')
245261
->setGitRepoName('reponame')
262+
->setTwitter('appwrite_io')
263+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
246264
->setDefaultHeaders([
247265
'X-Appwrite-Response-Format' => '0.7.0',
248266
])
@@ -265,6 +283,8 @@ function getSSLPage($url) {
265283
->setLicenseContent('test test test')
266284
->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')
267285
->setChangelog('**CHANGELOG**')
286+
->setTwitter('appwrite_io')
287+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
268288
->setDefaultHeaders([
269289
'X-Appwrite-Response-Format' => '0.7.0',
270290
])
@@ -289,6 +309,8 @@ function getSSLPage($url) {
289309
->setWarning('**WORK IN PROGRESS - NOT READY FOR USAGE**')
290310
->setChangelog('**CHANGELOG**')
291311
->setVersion('0.0.1')
312+
->setTwitter('appwrite_io')
313+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
292314
->setDefaultHeaders([
293315
'X-Appwrite-Response-Format' => '0.7.0',
294316
])
@@ -311,6 +333,8 @@ function getSSLPage($url) {
311333
->setVersion('0.0.1')
312334
->setGitUserName('repoowner')
313335
->setGitRepoName('reponame')
336+
->setTwitter('appwrite_io')
337+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
314338
->setDefaultHeaders([
315339
'X-Appwrite-Response-Format' => '0.7.0',
316340
])
@@ -333,6 +357,8 @@ function getSSLPage($url) {
333357
->setVersion('0.0.1')
334358
->setGitUserName('repoowner')
335359
->setGitRepoName('reponame')
360+
->setTwitter('appwrite_io')
361+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
336362
->setDefaultHeaders([
337363
'X-Appwrite-Response-Format' => '0.7.0',
338364
])
@@ -364,6 +390,8 @@ function getSSLPage($url) {
364390
->setVersion('0.0.1')
365391
->setGitUserName('repoowner')
366392
->setGitRepoName('reponame')
393+
->setTwitter('appwrite_io')
394+
->setDiscord('564160730845151244', 'https://appwrite.io/discord')
367395
// ->setDefaultHeaders([
368396
// 'X-Appwrite-Response-Format' => '0.7.0',
369397
// ])

src/SDK/SDK.php

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,30 @@ public function setExamples($text)
440440
return $this;
441441
}
442442

443+
/**
444+
* @param string $channel
445+
* @param string $url
446+
* @return $this
447+
*/
448+
public function setDiscord(string $channel, string $url)
449+
{
450+
$this->setParam('discordChannel', $channel);
451+
$this->setParam('discordUrl', $url);
452+
453+
return $this;
454+
}
455+
456+
/**
457+
* @param string $handle
458+
* @return $this
459+
*/
460+
public function setTwitter(string $handle)
461+
{
462+
$this->setParam('twitterHandle', $handle);
463+
464+
return $this;
465+
}
466+
443467
/**
444468
* @param string $key
445469
* @param string $value

templates/cli/README.md.twig

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
4-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
5+
{% if sdk.twitterHandle %}
6+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
7+
{% endif %}
8+
{% if sdk.discordChannel %}
9+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
10+
{% endif %}
511
{% if sdk.warning %}
612

713
{{ sdk.warning }}

templates/dart/README.md.twig

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
[![pub package](https://img.shields.io/pub/v/{{ language.params.packageName }}.svg)](https://pub.dartlang.org/packages/{{ language.params.packageName }})
4-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
5-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
[![pub package](https://img.shields.io/pub/v/{{ language.params.packageName }}.svg?style=flat-square)](https://pub.dartlang.org/packages/{{ language.params.packageName }})
4+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
5+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
6+
{% if sdk.twitterHandle %}
7+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
8+
{% endif %}
9+
{% if sdk.discordChannel %}
10+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
11+
{% endif %}
612
{% if sdk.warning %}
713

814
{{ sdk.warning|raw }}

templates/deno/README.md.twig

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
4-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
5+
{% if sdk.twitterHandle %}
6+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
7+
{% endif %}
8+
{% if sdk.discordChannel %}
9+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
10+
{% endif %}
511
{% if sdk.warning %}
612

713
{{ sdk.warning|raw }}

templates/dotnet/README.md.twig

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
4-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
5+
{% if sdk.twitterHandle %}
6+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
7+
{% endif %}
8+
{% if sdk.discordChannel %}
9+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
10+
{% endif %}
511
{% if sdk.warning %}
612

713
{{ sdk.warning|raw }}

templates/flutter/README.md.twig

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
[![pub package](https://img.shields.io/pub/v/{{ language.params.packageName }}.svg)](https://pub.dartlang.org/packages/{{ language.params.packageName }})
4-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
5-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
[![pub package](https://img.shields.io/pub/v/{{ language.params.packageName }}?style=flat-square.svg)](https://pub.dartlang.org/packages/{{ language.params.packageName }})
4+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
5+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
6+
{% if sdk.twitterHandle %}
7+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
8+
{% endif %}
9+
{% if sdk.discordChannel %}
10+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
11+
{% endif %}
612
{% if sdk.warning %}
713

814
{{ sdk.warning|raw }}

templates/go/README.md.twig

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
4-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
5+
{% if sdk.twitterHandle %}
6+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
7+
{% endif %}
8+
{% if sdk.discordChannel %}
9+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
10+
{% endif %}
511
{% if sdk.warning %}
612

713
{{ sdk.warning|raw }}

templates/java/README.md.twig

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
4-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
5+
{% if sdk.twitterHandle %}
6+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
7+
{% endif %}
8+
{% if sdk.discordChannel %}
9+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
10+
{% endif %}
511
{% if sdk.warning %}
612

713
{{ sdk.warning|raw }}

templates/node/README.md.twig

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# {{ spec.title }} {{sdk.name}} SDK
22

3-
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?v=1)
4-
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?v=1)
3+
![License](https://img.shields.io/github/license/{{ sdk.gitUserName|url_encode }}/{{ sdk.gitRepoName|url_encode }}.svg?style=flat-square)
4+
![Version](https://img.shields.io/badge/api%20version-{{ spec.version|url_encode }}-blue.svg?style=flat-square)
5+
{% if sdk.twitterHandle %}
6+
[![Twitter Account](https://img.shields.io/twitter/follow/{{ sdk.twitterHandle }}?color=00acee&label=twitter&style=flat-square)](https://twitter.com/{{ sdk.twitterHandle }})
7+
{% endif %}
8+
{% if sdk.discordChannel %}
9+
[![Discord](https://img.shields.io/discord/{{ sdk.discordChannel }}?label=discord&style=flat-square)]({{ sdk.discordUrl }})
10+
{% endif %}
511
{% if sdk.warning %}
612

713
{{ sdk.warning|raw }}

0 commit comments

Comments
 (0)