Skip to content

Commit eb39a58

Browse files
committed
Fix README doc location.
1 parent a842e60 commit eb39a58

1 file changed

Lines changed: 38 additions & 42 deletions

File tree

README.md

Lines changed: 38 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ sudo npm install -g --verbose https://github.com/liaScript/LiaScript-Exporter
4848

4949
On Windows you might need to run the terminal with administrator-privileges.
5050

51-
## Basic usage
51+
## Basic CLI usage
5252

5353
If you have installed the package, you can now use `liaex` or
5454
`liascript-exporter`. If you type one of the following commands, you will get
@@ -88,45 +88,6 @@ Learn more: https://scorm.com/scorm-explained/
8888
Known SCORM configurations per LMS:
8989
https://www.npmjs.com/package/@liascript/exporter#scorm-examples
9090

91-
## GitHub Action
92-
93-
Export your LiaScript courses directly in GitHub workflows with this GitHub Action.
94-
95-
### Quick Start
96-
97-
Add to your `.github/workflows/export.yml`:
98-
99-
```yaml
100-
name: Export Course
101-
on: [push]
102-
103-
jobs:
104-
export:
105-
runs-on: ubuntu-latest
106-
steps:
107-
- uses: actions/checkout@v4
108-
109-
- name: Export to SCORM
110-
uses: ./
111-
with:
112-
input-file: 'README.md'
113-
format: 'scorm1.2'
114-
output-name: 'my-course'
115-
scorm-organization: 'My Organization'
116-
117-
- name: Upload SCORM package
118-
uses: actions/upload-artifact@v4
119-
with:
120-
name: scorm-package
121-
path: '*.zip'
122-
```
123-
124-
### Documentation
125-
126-
For complete GitHub Action documentation, inputs, outputs, and more examples, see: [`action/README.md`](action/README.md)
127-
128-
## CLI Usage
129-
13091
--scorm-organization set the organization title
13192
--scorm-masteryScore set the scorm masteryScore (a value between 0
13293
-- 100), default is 0
@@ -996,6 +957,43 @@ This will be translated to:
996957
}
997958
```
998959
960+
## GitHub Action
961+
962+
Export your LiaScript courses directly in GitHub workflows with this GitHub Action.
963+
964+
### Quick Start
965+
966+
Add to your `.github/workflows/export.yml`:
967+
968+
```yaml
969+
name: Export Course
970+
on: [push]
971+
972+
jobs:
973+
export:
974+
runs-on: ubuntu-latest
975+
steps:
976+
- uses: actions/checkout@v4
977+
978+
- name: Export to SCORM
979+
uses: ./
980+
with:
981+
input-file: 'README.md'
982+
format: 'scorm1.2'
983+
output-name: 'my-course'
984+
scorm-organization: 'My Organization'
985+
986+
- name: Upload SCORM package
987+
uses: actions/upload-artifact@v4
988+
with:
989+
name: scorm-package
990+
path: '*.zip'
991+
```
992+
993+
### Documentation
994+
995+
For complete GitHub Action documentation, inputs, outputs, and more examples, see: [`action/README.md`](action/README.md)
996+
999997
## TODOs & Contributions
1000998
1001999
* Further exporter
@@ -1006,8 +1004,6 @@ This will be translated to:
10061004
10071005
* Integration into the Atom IDE
10081006
1009-
* GitHub actions to automate building during push ...
1010-
10111007
### Custom extensions
10121008
10131009
If you are interested in creating integrations for other systems by your own,

0 commit comments

Comments
 (0)