Skip to content

Commit 289f0fe

Browse files
authored
[Doc] Version histoty update and usage update
1 parent 84dd187 commit 289f0fe

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,23 @@ curl -LS -o /config/scripts/cloudflare-ddns-edgeos.tar.gz https://cdn.jsdelivr.n
2828

2929
### 2 - Deploy
3030

31-
+ `tar -xvf /config/scripts/cloudflare-ddns-edgeos.tar.gz`
31+
#### Extraction
3232

33-
+ Alter variables in `/config/scripts/cloudflare-ddns-edgeos/cfddns.sh`.
33+
```bash
34+
tar -xvf /config/scripts/cloudflare-ddns-edgeos.tar.gz
35+
```
36+
37+
#### Global Parameters Editing
38+
39+
**!!! This step is IMPORTANT !!!**
40+
41+
Alter variables in `/config/scripts/cloudflare-ddns-edgeos/cfddns.sh`
42+
43+
Meanings & where-can-be-found of global parameters is provided in `cfddns.sh` via code comments.
3444

35-
+ `+x` to files using `chmod +x /config/scripts/cloudflare-ddns-edgeos/cfddns.sh`
45+
#### Extra Steps
46+
47+
`+x` to files using `chmod +x /config/scripts/cloudflare-ddns-edgeos/cfddns.sh`
3648

3749
### 3 - Test
3850

@@ -68,6 +80,14 @@ Thus...this project.
6880

6981
## Release/Feature History
7082

83+
### v1.1
84+
85+
+ Automatically create dns record (No need to create record manually in advance).
86+
87+
+ Continuous-Delivery via `Github Action` is configured, build and push artifact to `releases` branch.
88+
89+
+ Documentation & comments update (following shell style guideline).
90+
7191
### v1.0-hotfix
7292

7393
+ Fix script import error. (MUST use absolute path to import `cloudflare-ddns`)
@@ -84,4 +104,4 @@ Copyright © 2022 MijazzChan <mijazz@qq.com>
84104

85105
This work is free. You can redistribute it and/or modify it under the
86106
terms of the Do What The Fuck You Want To Public License, Version 2,
87-
as published by Sam Hocevar. See http://www.wtfpl.net/ for more details.
107+
as published by Sam Hocevar. See http://www.wtfpl.net/ for more details.

0 commit comments

Comments
 (0)