Skip to content

Commit 03abd81

Browse files
author
Denis Trotsenko
committed
Updated README
1 parent 9d69149 commit 03abd81

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Kotpass
2-
![Build & Test](https://github.com/keemobile/kotpass/actions/workflows/gradle.yml/badge.svg) [![](https://jitpack.io/v/keemobile/kotpass.svg)](https://jitpack.io/#keemobile/kotpass)
2+
![Build & Test](https://img.shields.io/github/actions/workflow/status/keemobile/kotpass/gradle.yml?label=Build%20%26%20Test&style=flat-square)
3+
[![](https://jitpack.io/v/keemobile/kotpass.svg?style=flat-square)](https://jitpack.io/#keemobile/kotpass) ![badge][badge-jvm]
34

4-
Library provides reading/writing support for KDBX files in Kotlin (including newest format version 4.1). It's suitable for Mobile, Desktop and Backend JVM projects. Functional style API makes it convenient for MVI/Redux like architectures.
5+
[badge-jvm]: http://img.shields.io/badge/-JVM-DB413D.svg?style=flat-square
6+
7+
The library offers reading and writing support for [KeePass](https://en.wikipedia.org/wiki/KeePass) (KDBX) files in Kotlin, including the latest format version 4.1. It is suitable for Mobile, Desktop, and Backend JVM projects. The functional style API makes it convenient for MVI-like architectures.
58

69
## See it in action
710

8-
This library is used as backbone of **KeeMobile** Password Manager, check it out:
11+
This library is used as backbone of [KeeMobile](https://keemobile.app) password manager, check it out:
912

10-
[<img src='https://play-lh.googleusercontent.com/VSMqudfH58XxCtn3Il9sUq6JtEHlShVdmxWSpLlLk2JrOG-sE2nbBTLQOkMMbUlSjw=s360-rw' height='80'/>](https://play.google.com/store/apps/details?id=app.keemobile)
11-
[<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width='200'/>](https://play.google.com/store/apps/details?id=app.keemobile)
13+
[<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width='160'/>](https://play.google.com/store/apps/details?id=app.keemobile)
1214

1315
## Installation
1416

@@ -30,6 +32,8 @@ dependencies {
3032

3133
## Usage
3234

35+
### 🧬 [Api reference](https://keemobile.github.io/kotpass)
36+
3337
Reading from file:
3438

3539
``` kotlin
@@ -40,9 +44,9 @@ val database = File("testfile.kdbx")
4044
KeePassDatabase.decode(inputStream, credentials)
4145
}
4246
```
43-
Database is represented as immutable object, in order to alter it use a set of modifier extensions.
47+
`KeePassDatabase` is represented as immutable object, in order to alter it use a set of modifier extensions.
4448

45-
Each time new Database object is returned:
49+
Each time new `KeePassDatabase` object is returned:
4650

4751
``` kotlin
4852
val groupUuid = UUID.fromString("c997344c-952b-e02b-06a6-29510ce71a12")

0 commit comments

Comments
 (0)