Skip to content

Commit 4cdc402

Browse files
committed
[feature] Update README.md for the latest version
1 parent 4c3a2e9 commit 4cdc402

File tree

1 file changed

+36
-31
lines changed

1 file changed

+36
-31
lines changed

README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,49 @@
1-
# Corpus Query Language module for eXist-db
1+
# Corpus Query Language module for Elemental or eXist-db
22
[![Build Status](https://github.com/BCDH/cql-module/actions/workflows/ci.yml/badge.svg)](https://github.com/BCDH/cql-module/actions/workflows/ci.yml)
33
[![Java 8+](https://img.shields.io/badge/java-8+-blue.svg)](http://java.oracle.com)
44
[![License](https://img.shields.io/badge/license-GPL%202-blue.svg)](https://www.gnu.org/licenses/gpl-2.0.html)
5-
[![Download](https://img.shields.io/badge/download-version%201.3.0-ff69b4.svg)](http://search.maven.org/remotecontent?filepath=org/humanistika/exist/module/cql-module/1.3.0/cql-module-1.3.0-exist.jar)
5+
[![Maven Central](https://img.shields.io/maven-central/v/org.humanistika.exist.module/cql-module?logo=apachemaven&label=maven+central&color=green)](https://search.maven.org/search?q=g:org.humanistika.exist.module)
66

7-
This is an XQuery Function Extension Module for eXist-db. The module provides a CQL (Corpus Query Language) to XML parser based on [exquery/corpusql-parser](https://github.com/exquery/corpusql-parser).
7+
This is an XQuery Function Extension Module for Elemental or eXist-db. The module provides a CQL (Corpus Query Language) to XML parser based on [exquery/corpusql-parser](https://github.com/exquery/corpusql-parser).
88

99

10-
## Compiling
11-
Requirements: Java 8, Maven 3.
12-
13-
1. `git clone https://github.com/bcdh/cql-module.git`
14-
15-
2. `cd cql-module`
16-
17-
3. `mvn package`
18-
19-
20-
## Installation into eXist-db
21-
You can install the module into eXist-db in either one of two ways:
10+
## Installation into Elemental or eXist-db
11+
You can install the module into Elemental or eXist-db in either one of two ways:
2212
1. As an EXPath Package (.xar file)
2313
2. Directly as a XQuery Java Extension Module (.jar file)
2414

25-
### EXPath Package Installation into eXist-db (.xar)
26-
1. If you have compiled yourself (see above), you can take the `cql-module/target/cql-module-1.4.0-SNAPSHOT.xar` file and upload it via eXist's EXPath Package Manager app in its Dashboard
15+
### Easy Option - EXPath Package Installation into eXist-db (.xar)
16+
1. Download the latest XAR file from the releases here: https://github.com/BCDH/cql-module/releases/
17+
* or if you have [compiled](#compiling) the code yourself you can find the `cql-module-1.5.0-SNAPSHOT.xar` file in the `target` subfolder.
18+
19+
2. You can take the .xar file and upload it via Elemental or eXist-db's EXPath Package Manager app from its Dashboard
2720

28-
2. Otherwise, the latest release version will also be available from the eXist's EXPath Package Manager app in its Dashboard
21+
3. Restart Elemental (or eXist-db)
2922

23+
### Advanced Option - Direct Installation into eXist-db (.jar)
24+
1. Download the latest Jar file from the releases here: https://github.com/BCDH/cql-module/releases/
25+
* or if you have [compiled](#compiling) the code yourself you can find the `cql-module-1.5.0-SNAPSHOT-exist.jar` file in the `target` subfolder.
3026

31-
### Direct Installation into eXist-db (.jar)
32-
1. If you have compiled yourself (see above), copy `cql-module/target/cql-module-1.4.0-SNAPSHOT-exist.jar` to `$EXIST_HOME/lib`, or download `cql-module-1.3.0-exist.jar` from Maven Central to `$EXIST_HOME/lib`
27+
2. Copy the .jar file to either `$ELEMENTAL_HOME/lib` (or substitute `$EXIST_HOME` instead of `$ELEMENTAL_HOME` for eXist-db).
3328

34-
2. Edit `$EXIST_HOME/etc/conf.xml` and add the following to the `<builtin-modules>`:
29+
3. Edit `$ELEMENTAL_HOME/etc/conf.xml` and add the following to the `<builtin-modules>`:
3530

3631
```xml
3732
<module uri="http://humanistika.org/ns/exist/module/cql" class="org.humanistika.exist.module.cqlmodule.CQLModule"/>
3833
```
39-
3. Edit `$EXIST_HOME/etc/startup.xml` and add the following to the `<dependencies>`:
34+
4. Edit `$ELEMENTAL_HOME/etc/startup.xml` and add the following to the `<dependencies>`:
4035

41-
```xml
42-
<dependency>
43-
<groupId>org.humanistika.exist.module</groupId>
44-
<artifactId>cql-module</artifactId>
45-
<version>1.4.0-SNAPSHOT</version> <!-- modify to the version you are using -->
46-
<relativePath>cql-module-1.4.0-SNAPSHOT-exist.jar</relativePath> <!-- this should reflect the exact filename in lib folder -->
47-
</dependency>
48-
```
36+
```xml
37+
<dependency>
38+
<groupId>org.humanistika.exist.module</groupId>
39+
<artifactId>cql-module</artifactId>
40+
<version>1.5.0-SNAPSHOT</version> <!-- NOTE: Modify this to the version you are using -->
41+
<relativePath>cql-module-1.5.0-SNAPSHOT-exist.jar</relativePath> <!-- NOTE: this should reflect the exact filename in lib folder that you copied earlier -->
42+
</dependency>
43+
```
44+
45+
5. Restart Elemental (or eXist-db)
4946

50-
4. Restart eXist-db
5147

5248
## Usage
5349
The module exports a single function for use in your XQuery(s), for example:
@@ -74,3 +70,12 @@ would produce the output:
7470
```
7571

7672
For further examples of the XML that will be produced see [CorpusQLXMLVisitorTest](https://github.com/BCDH/cql-module/blob/master/src/test/java/org/humanistika/exist/module/cqlmodule/CorpusQLXMLVisitorTest.java#L42)
73+
74+
## Compiling
75+
Requirements: Java 8, Maven 3.
76+
77+
1. `git clone https://github.com/bcdh/cql-module.git`
78+
79+
2. `cd cql-module`
80+
81+
3. `mvn package`

0 commit comments

Comments
 (0)