Skip to content

Commit 8721a8f

Browse files
authored
Merge pull request #107 from jchunk-io/dev/pablosanchi/docs
docs: add detailed module install in root readme
2 parents d66b35e + b8e9917 commit 8721a8f

File tree

4 files changed

+31
-166
lines changed

4 files changed

+31
-166
lines changed

README.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,50 @@ JChunk project is simple library that enables different types of text splitting
99

1010
## Docs
1111

12-
### Chunkers
13-
- [Fixed Chunker](jchunk-fixed/README.md)
14-
- [Recursive Character Chunker](jchunk-recursive-character/README.md)
15-
- [Semantic Chunker](jchunk-semantic/README.md)
16-
17-
### More
18-
- [Jchunk Documentation](docs/modules/ROOT/pages/index.adoc)
12+
[Jchunk Website](https://jchunk-io.github.io/jchunk/)
1913

2014
## Installing
2115

22-
### Maven
16+
### Fixed Chunker
17+
18+
```xml
19+
<dependency>
20+
<groupId>io.jchunk</groupId>
21+
<artifactId>jchunk-fixed</artifactId>
22+
<version>${jchunk.version}</version>
23+
</dependency>
24+
```
25+
26+
```groovy
27+
implementation("io.jchunk:jchunk-fixed:${JCHUNK_VERSION}")
28+
```
29+
30+
### Recursive Chunker
2331

2432
```xml
2533
<dependency>
2634
<groupId>io.jchunk</groupId>
27-
<artifactId>jchunk-...</artifactId> <!-- replace dots with desired module name -->
35+
<artifactId>jchunk-recursive-character</artifactId>
2836
<version>${jchunk.version}</version>
2937
</dependency>
3038
```
3139

32-
### Gradle
40+
```groovy
41+
implementation("io.jchunk:jchunk-recursive-character:${JCHUNK_VERSION}")
42+
```
43+
44+
### Semantic Chunker
45+
46+
```xml
47+
<dependency>
48+
<groupId>io.jchunk</groupId>
49+
<artifactId>jchunk-semantic</artifactId>
50+
<version>${jchunk.version}</version>
51+
</dependency>
52+
```
3353

3454
```groovy
35-
implementation group: 'io.jchunk', name: 'jchunk-...', version: "${JCHUNK_VERSION}" // replace dots with desired module name
55+
implementation("io.jchunk:jchunk-semantic:${JCHUNK_VERSION}")
3656
```
3757

3858
## Building

jchunk-fixed/README.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

jchunk-recursive-character/README.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

jchunk-semantic/README.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

0 commit comments

Comments
 (0)