Skip to content

Commit

Permalink
feat: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
EdmonDantes committed Oct 8, 2023
1 parent 2fa7a62 commit b0f683a
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Simple kotlin multipart library

Small library for working with multipart content type in http protocol

<!-- TOC -->
* [How to add library to you project](#how-to-add-library-to-you-project)
* [Main classes](#main-classes)
<!-- TOC -->

### How to add library to you project

#### Maven

```xml

<dependency>
<groupId>io.github.edmondantes</groupId>
<artifactId>simple-kotlin-multipart</artifactId>
<version>${simple_library_version}</version>
</dependency>
```

#### Gradle (kotlin)

```kotlin
implementation("io.github.edmondantes:simple-kotlin-multipart:${simple_library_version}")
```

#### Gradle (groovy)

```groovy
implementation "io.github.edmondantes:simple-kotlin-multipart:${simple_library_version}"
```

### Main classes

Class `io.github.edmondantesx.multipart.Multipart` is main representation of multipart content type.

For transformation this class you can use `io.github.edmondantes.multipart.impl.DefaultMultipartEncoderDecoder`
Empty file modified gradlew
100644 → 100755
Empty file.
Empty file modified gradlew.bat
100644 → 100755
Empty file.

0 comments on commit b0f683a

Please sign in to comment.