Skip to content

Commit e1b57d2

Browse files
committed
docs(readme): typo
fix ci.yml
1 parent e06e128 commit e1b57d2

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

.github/workflows/ci.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,28 @@ name: CI
22
on: [push, pull_request]
33
jobs:
44
build:
5-
name: Build and Test (${{ matrix.os }} / OpenJDK ${{ matrix.jdk }})
5+
name: Exist ${{ matrix.exist-version }} (Java ${{ matrix.java-version }}) build and test
66
strategy:
77
fail-fast: true
88
matrix:
9-
exist-version: [latest, 6.2.0, 5.3.0]
10-
jdk: ['8', '17']
9+
exist-version: [latest, 6.2.0]
10+
java-version: ['8', '17']
1111
os: [ubuntu-latest]
1212
exclude:
1313
- exist-version: 6.2.0
1414
java-version: 17
15-
- exist-version: 5.3.0
16-
java-version: 17
1715
- exist-version: latest
1816
java-version: 11
1917

2018
runs-on: ${{ matrix.os }}
2119
steps:
2220
- uses: actions/checkout@v4
23-
- name: Set up JDK ${{ matrix.jdk }}
21+
- name: Set up JDK ${{ matrix.java-version }}
2422
uses: actions/setup-java@v4
2523
with:
2624
distribution: temurin
2725
cache: maven
28-
java-version: ${{ matrix.jdk }}
26+
java-version: ${{ matrix.java-version }}
2927
- name: Maven Build
3028
run: mvn clean package
3129

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
11
# eXist-db Function Documentation Browser App
2+
23
[![Build Status](https://travis-ci.com/eXist-db/function-documentation.svg?branch=master)](https://travis-ci.com/eXist-db/function-documentation)
34
[![eXist-db version](https://img.shields.io/badge/eXist_db-4.0.0-blue.svg)](http://www.exist-db.org/exist/apps/homepage/index.html)
45

56
<img src="src/main/xar-resources/icon.png" align="left" width="15%"/>
67

7-
This repository contains the function documentation borwser app for the [eXist-db native XML database](http://www.exist-db.org).
8+
This repository contains the function documentation browser app for the [eXist-db native XML database](http://www.exist-db.org).
89

910
## Dependencies
10-
- [Maven](https://maven.apache.org): 3.5.2
11-
- [eXist-db](http://exist-db.org): 4.0.0
11+
12+
- [Maven](https://maven.apache.org): `3.5.2`
13+
- [eXist-db](http://exist-db.org): `4.0.0`
1214

1315
## Installation
14-
- Just go to your eXist server's Dashboard and select Function Documentation.
15-
- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/).
16+
17+
- Just go to your eXist server's Dashboard and select Function Documentation.
18+
- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/).
1619

1720
## Building from source
18-
1. Clone the repository to your system:
19-
```bash
20-
$ git clone https://github.com/exist-db/function-documentation.git
21-
```
2221

23-
2. Build the function documentation application:
24-
```bash
25-
$ cd function-documentation
26-
$ mvn clean package
27-
```
28-
The compiled `.xar` file is located in the `/target` directory
22+
1. Clone the repository to your system:
23+
24+
```bash
25+
git clone https://github.com/exist-db/function-documentation.git
26+
```
2927

30-
3. Install this file via the Dashboard > Package Manager.
28+
2. Build the function documentation application:
29+
30+
```bash
31+
cd function-documentation
32+
mvn clean package
33+
```
34+
35+
The compiled `.xar` file is located in the `/target` directory
36+
37+
3. Install this file via the Dashboard > Package Manager.
3138

3239
## License
40+
3341
LGPLv2.1 [eXist-db.org](http://exist-db.org/exist/apps/homepage/index.html)

0 commit comments

Comments
 (0)