Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alllex committed Aug 3, 2023
1 parent 569b503 commit ff58533
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Maven Central](https://img.shields.io/maven-central/v/me.alllex.parsus/parsus.svg?color=success)](https://search.maven.org/search?q=g:me.alllex.parsus)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Gradle build](https://github.com/alllex/parsus/actions/workflows/gradle.yml/badge.svg)](https://github.com/alllex/parsus/actions/workflows/gradle.yml)
[![Gradle build](https://github.com/alllex/parsus/actions/workflows/check.yml/badge.svg)](https://github.com/alllex/parsus/actions/workflows/check.yml)

A framework for writing composable parsers for JVM, JS and Kotlin/Native based on Kotlin Coroutines.

Expand Down Expand Up @@ -35,24 +35,48 @@ val ast = booleanGrammar.parse("a & (b1 -> c1) | a1 & !b | !(a1 -> a2) -> a").ge

## Usage

Using with Gradle:
<details open>
<summary>Using with Gradle for JVM projects</summary>

```kotlin
dependencies {
implementation("me.alllex.parsus:parsus-jvm:0.4.0")
implementation("me.alllex.parsus:parsus-jvm:0.5.4")
}
```

Using with Maven:
</details>

<details open>
<summary>Using with Gradle for Multiplatform projects</summary>

```kotlin
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("me.alllex.parsus:parsus:0.5.0")
}
}
}
}
```

</details>


<details>
<summary>Using with Maven for JVM projects</summary>

```xml
<dependency>
<groupId>me.alllex.parsus</groupId>
<artifactId>parsus-jvm</artifactId>
<version>0.4.0</version>
<version>0.5.4</version>
</dependency>
```

</details>

## Features

* **0-dependencies**. Parsus only depends on Kotlin Standard Library.
Expand Down

0 comments on commit ff58533

Please sign in to comment.