Skip to content

Commit 0eaa8d4

Browse files
chore: update template readme files (#171)
* chore: update template readme files * chore: readme title fix Co-authored-by: Igor Randjelovic <rigor789@gmail.com>
1 parent be5ac28 commit 0eaa8d4

File tree

20 files changed

+88
-127
lines changed

20 files changed

+88
-127
lines changed

packages/template-blank-ng/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ App templates help you jump start your native cross-platform apps with built-in
55
Execute the following command to create an app from this template:
66

77
```
8-
tns create my-blank-ng --template tns-template-blank-ng
8+
ns create my-blank-ng --template @nativescript/template-blank-ng
99
```
1010

11-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm] (https://www.npmjs.com/package/tns-template-blank-ng).
11+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-blank-ng).
1212
1313
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
1414

@@ -17,7 +17,7 @@ If you want to create a new app that uses the source of the template from the `m
1717
git clone git@github.com:NativeScript/nativescript-app-templates.git
1818
1919
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
20-
tns create my-blank-ng --template nativescript-app-templates/packages/template-blank-ng
20+
ns create my-blank-ng --template nativescript-app-templates/packages/template-blank-ng
2121
```
2222

2323
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -38,7 +38,7 @@ There is a single blank component that sets up an empty layout:
3838
## Get Help
3939
The NativeScript framework has a vibrant community that can help when you run into problems.
4040

41-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
41+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
4242

4343
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
4444

packages/template-blank-react/README.md

Lines changed: 9 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,33 @@
1-
# React NativeScript Blank Template
2-
1+
# NativeScript with React Blank Template
32
App templates help you jump start your native cross-platform apps with built-in UI elements and best practices. Save time writing boilerplate code over and over again when you create new apps.
43

5-
## Quick Start from NPM package
4+
## Quick Start
65
Execute the following command to create an app from this template:
76

87
```
9-
ns create my-blank-react --react
10-
11-
cd my-blank-react
12-
npm install
13-
14-
ns preview
15-
# or
16-
ns run android
17-
# or
18-
ns run ios
19-
```
20-
21-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/tns-template-blank-react).
22-
23-
<!--
24-
## Quick start from the latest master
25-
26-
```sh
27-
ns create my-blank-react --template https://github.com/shirakaba/tns-template-blank-react/tarball/master
8+
ns create my-blank-react --template @nativescript/template-blank-react
289
```
2910

30-
## Building from a local clone of the repo
11+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-blank-react).
3112
3213
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
3314

3415
```
3516
# clone nativescript-app-templates monorepo locally
36-
git clone https://github.com/shirakaba/tns-template-blank-react.git
17+
git clone git@github.com:NativeScript/nativescript-app-templates.git
3718
3819
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
39-
ns create my-blank-react --template tns-template-blank-react
40-
41-
cd my-blank-react
42-
npm install
43-
44-
ns preview
45-
# or
46-
ns run android
47-
# or
48-
ns run ios
20+
ns create my-blank-react --template nativescript-app-templates/packages/template-blank-react
4921
```
50-
-->
51-
52-
**NB:** Please, keep in mind that the master branch may refer to dependencies that are not on NPM yet!
53-
54-
## Walkthrough
55-
56-
### Architecture
57-
There is a single blank component located in:
58-
- `/components/AppContainer.tsx` - sets up an empty page layout.
5922

60-
**Home** page has the following components:
61-
- `<actionBar>` - It holds the title of the page.
62-
- `<gridLayout>` - The main page layout that should contains all the page content.
23+
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
6324

6425
## Get Help
6526
The NativeScript framework has a vibrant community that can help when you run into problems.
6627

67-
Try [joining the NativeScript community Slack](https://app.slack.com/client/T0L97VCSY/). The Slack `#react` channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
28+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
6829

69-
If you have found an issue with this template, please report the problem in this repository's [Issues page](https://github.com/shirakaba/tns-template-blank-react/issues).
30+
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
7031

7132
## Contributing
7233

packages/template-blank-ts/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ App templates help you jump start your native cross-platform apps with built-in
55
Execute the following command to create an app from this template:
66

77
```
8-
tns create my-blank-ts --template tns-template-blank-ts
8+
ns create my-blank-ts --template @nativescript/template-blank-ts
99
```
1010

11-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm] (https://www.npmjs.com/package/tns-template-blank-ts).
11+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-blank-ts).
1212
1313
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
1414

@@ -17,7 +17,7 @@ If you want to create a new app that uses the source of the template from the `m
1717
git clone git@github.com:NativeScript/nativescript-app-templates.git
1818
1919
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
20-
tns create my-blank-ts --template nativescript-app-templates/packages/template-blank-ts
20+
ns create my-blank-ts --template nativescript-app-templates/packages/template-blank-ts
2121
```
2222

2323
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -38,7 +38,7 @@ There is a single blank page module that sets up an empty layout:
3838
## Get Help
3939
The NativeScript framework has a vibrant community that can help when you run into problems.
4040

41-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
41+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
4242

4343
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
4444

packages/template-blank-vue/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ App templates help you jump start your native cross-platform apps with built-in
55
Execute the following command to create an app from this template:
66

77
```
8-
tns create my-blank-vue --template tns-template-blank-vue
8+
ns create my-blank-vue --template @nativescript/template-blank-vue
99
```
1010

11-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/tns-template-blank-vue).
11+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-blank-vue).
1212
1313
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
1414

@@ -17,7 +17,7 @@ If you want to create a new app that uses the source of the template from the `m
1717
git clone git@github.com:NativeScript/nativescript-app-templates.git
1818
1919
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
20-
tns create my-blank-vue --template nativescript-app-templates/packages/template-blank-vue
20+
ns create my-blank-vue --template nativescript-app-templates/packages/template-blank-vue
2121
```
2222

2323
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -35,7 +35,7 @@ There is a single blank component located in:
3535
## Get Help
3636
The NativeScript framework has a vibrant community that can help when you run into problems.
3737

38-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
38+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
3939

4040
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
4141

packages/template-blank/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ App templates help you jump start your native cross-platform apps with built-in
55
Execute the following command to create an app from this template:
66

77
```
8-
tns create my-blank-js --template tns-template-blank
8+
ns create my-blank-js --template @nativescript/template-blank
99
```
1010

11-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm] (https://www.npmjs.com/package/tns-template-blank).
11+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-blank).
1212
1313
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
1414

@@ -17,7 +17,7 @@ If you want to create a new app that uses the source of the template from the `m
1717
git clone git@github.com:NativeScript/nativescript-app-templates.git
1818
1919
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
20-
tns create my-blank-js --template nativescript-app-templates/packages/template-blank
20+
ns create my-blank-js --template nativescript-app-templates/packages/template-blank
2121
```
2222

2323
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -38,7 +38,7 @@ There is a single blank page module that sets up an empty layout:
3838
## Get Help
3939
The NativeScript framework has a vibrant community that can help when you run into problems.
4040

41-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
41+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
4242

4343
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
4444

packages/template-drawer-navigation-ng/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ App template featuring a RadSideDrawer component for navigation. The RadSideDraw
1919
Execute the following command to create an app from this template:
2020

2121
``` shell
22-
tns create my-drawer-ng --template tns-template-drawer-navigation-ng
22+
ns create my-drawer-ng --template @nativescript/template-drawer-navigation-ng
2323
```
2424

25-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/tns-template-drawer-navigation-ng).
25+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-drawer-navigation-ng).
2626
2727
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
2828

@@ -31,7 +31,7 @@ If you want to create a new app that uses the source of the template from the `m
3131
git clone git@github.com:NativeScript/nativescript-app-templates.git
3232

3333
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
34-
tns create my-drawer-ng --template nativescript-app-templates/packages/template-drawer-navigation-ng
34+
ns create my-drawer-ng --template nativescript-app-templates/packages/template-drawer-navigation-ng
3535
```
3636

3737
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -72,7 +72,7 @@ It has 3 global style files that are located at the root of the app folder:
7272

7373
The NativeScript framework has a vibrant community that can help when you run into problems.
7474

75-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
75+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
7676

7777
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
7878

packages/template-drawer-navigation-ts/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ App template featuring a RadSideDrawer component for navigation. The RadSideDraw
1919
Execute the following command to create an app from this template:
2020

2121
``` shell
22-
tns create my-drawer-ts --template tns-template-drawer-navigation-ts
22+
ns create my-drawer-ts --template @nativescript/template-drawer-navigation-ts
2323
```
2424

25-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/tns-template-drawer-navigation-ng).
25+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-drawer-navigation-ts).
2626
2727
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
2828

@@ -31,7 +31,7 @@ If you want to create a new app that uses the source of the template from the `m
3131
git clone git@github.com:NativeScript/nativescript-app-templates.git
3232

3333
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
34-
tns create my-drawer-ts --template nativescript-app-templates/packages/template-drawer-navigation-ts
34+
ns create my-drawer-ts --template nativescript-app-templates/packages/template-drawer-navigation-ts
3535
```
3636

3737
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -72,7 +72,7 @@ It has 3 global style files that are located at the root of the app folder:
7272

7373
The NativeScript framework has a vibrant community that can help when you run into problems.
7474

75-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
75+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
7676

7777
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
7878

packages/template-drawer-navigation-vue/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ App template featuring a RadSideDrawer component for navigation. The RadSideDraw
1919
Execute the following command to create an app from this template:
2020

2121
``` shell
22-
tns create my-drawer-vue --template tns-template-drawer-navigation-vue
22+
ns create my-drawer-vue --template @nativescript/template-drawer-navigation-vue
2323
```
2424

25-
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/tns-template-drawer-navigation-vue).
25+
> Note: This command will create a new NativeScript app that uses the latest version of this template published to [npm](https://www.npmjs.com/package/@nativescript/template-drawer-navigation-vue).
2626
2727
If you want to create a new app that uses the source of the template from the `master` branch, you can execute the following:
2828

@@ -31,7 +31,7 @@ If you want to create a new app that uses the source of the template from the `m
3131
git clone git@github.com:NativeScript/nativescript-app-templates.git
3232

3333
# create app template from local source (all templates are in the 'packages' subfolder of the monorepo)
34-
tns create my-drawer-vue --template nativescript-app-templates/packages/template-drawer-navigation-vue
34+
ns create my-drawer-vue --template nativescript-app-templates/packages/template-drawer-navigation-vue
3535
```
3636

3737
**NB:** Please, have in mind that the master branch may refer to dependencies that are not on NPM yet!
@@ -72,7 +72,7 @@ It has 3 global style files that are located at the root of the app folder:
7272

7373
The NativeScript framework has a vibrant community that can help when you run into problems.
7474

75-
Try [joining the NativeScript community Slack](http://developer.telerik.com/wp-login.php?action=slack-invitation). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
75+
Try [joining the NativeScript community Slack](https://www.nativescript.org/slack-invitation-form). The Slack channel is a great place to get help troubleshooting problems, as well as connect with other NativeScript developers.
7676

7777
If you have found an issue with this template, please report the problem in the [NativeScript repository](https://github.com/NativeScript/NativeScript/issues).
7878

0 commit comments

Comments
 (0)