Skip to content

Commit d6e9a8d

Browse files
authored
Merge pull request #1 from NativeCLI/feature/self-update-doc
Add documentation for self-update
2 parents f78f035 + 496f566 commit d6e9a8d

File tree

3 files changed

+42
-1
lines changed

3 files changed

+42
-1
lines changed

Writerside/cfg/buildprofiles.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</variables>
1818

1919
<footer>
20-
<link href="https://nativephp.com/ios?ref=nativecli">Join NativePHP Early Access Program!</link>
20+
<link href="https://nativephp.com/ios?ref=nativecli">Join NativePHP EAP!</link>
2121
</footer>
2222

2323
<build-profile instance="n">

Writerside/n.tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<toc-element topic="New.md"/>
1616
<toc-element topic="cache-clear.md"/>
1717
<toc-element topic="check-update.md"/>
18+
<toc-element topic="self-update.md"/>
1819
<toc-element topic="update.md"/>
1920
</toc-element>
2021
<toc-element topic="Contributing.md"/>

Writerside/topics/self-update.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# self-update
2+
3+
This command provides an easy way to ensure that NativeCLI is always kept up to date.
4+
5+
<tip>
6+
This command is only available in NativeCLI version 1.0.0-release.1 and later.
7+
</tip>
8+
9+
## Command
10+
11+
Syntax:
12+
13+
```shell
14+
nativecli self-update [VERSION]
15+
```
16+
17+
## Options
18+
19+
Describe what each option is used for:
20+
21+
Version
22+
: No flag required. If a version is specified, NativeCLI will attempt to update to that version. If no version is specified, NativeCLI will update to the latest stable version.
23+
24+
## Examples
25+
26+
Update to the latest stable version:
27+
28+
```shell
29+
nativecli self-update
30+
```
31+
32+
Update to a specific version:
33+
34+
```shell
35+
nativecli self-update 1.0.0-beta.2
36+
```
37+
38+
<seealso>
39+
<!--Provide links to related how-to guides, overviews, and tutorials.-->
40+
</seealso>

0 commit comments

Comments
 (0)