Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 31 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,50 @@ JChunk project is simple library that enables different types of text splitting

## Docs

### Chunkers
- [Fixed Chunker](jchunk-fixed/README.md)
- [Recursive Character Chunker](jchunk-recursive-character/README.md)
- [Semantic Chunker](jchunk-semantic/README.md)

### More
- [Jchunk Documentation](docs/modules/ROOT/pages/index.adoc)
[Jchunk Website](https://jchunk-io.github.io/jchunk/)

## Installing

### Maven
### Fixed Chunker

```xml
<dependency>
<groupId>io.jchunk</groupId>
<artifactId>jchunk-fixed</artifactId>
<version>${jchunk.version}</version>
</dependency>
```

```groovy
implementation("io.jchunk:jchunk-fixed:${JCHUNK_VERSION}")
```

### Recursive Chunker

```xml
<dependency>
<groupId>io.jchunk</groupId>
<artifactId>jchunk-...</artifactId> <!-- replace dots with desired module name -->
<artifactId>jchunk-recursive-character</artifactId>
<version>${jchunk.version}</version>
</dependency>
```

### Gradle
```groovy
implementation("io.jchunk:jchunk-recursive-character:${JCHUNK_VERSION}")
```

### Semantic Chunker

```xml
<dependency>
<groupId>io.jchunk</groupId>
<artifactId>jchunk-semantic</artifactId>
<version>${jchunk.version}</version>
</dependency>
```

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

## Building
Expand Down
50 changes: 0 additions & 50 deletions jchunk-fixed/README.md

This file was deleted.

52 changes: 0 additions & 52 deletions jchunk-recursive-character/README.md

This file was deleted.

53 changes: 0 additions & 53 deletions jchunk-semantic/README.md

This file was deleted.