Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme updtate of tuvali #131

Merged
merged 1 commit into from
Jun 3, 2024
Merged
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
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,45 @@

> Warning: The library is under active development and no major version is released yet. Please anticipate non-backward compatible changes to the API and functional behavior in the upcoming releases.

# Tuvali - React native module library
This is the React native module for the [OpenID for Verifiable Presentations over BLE](https://tlodderstedt.github.io/openid-for-verifiable-presentations-offline-1_0-00.html) implementation to support sending vc/vp using Bluetooth Low Energy local channel.
# Tuvali - A library to send vc/vp using BLE.
This is the module for the [OpenID for Verifiable Presentations over BLE](https://tlodderstedt.github.io/openid-for-verifiable-presentations-offline-1_0-00.html) implementation to support sending vc/vp using Bluetooth Low Energy local channel.

This contains the source code for the ios, android modules as well as a sample app under `example/` folder. The sample app can be used for testing the modules being worked on in case it is needed.

## Installing this library as a dependency

## Usage as a Kotlin library (for native android)
The Tuvali kotlin artifact (.aar) has been published to Maven.
#### Adding as a Maven dependency.
- In settings.gradle.kts of your app modify the following:
```
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven("https://oss.sonatype.org/content/repositories/snapshots/")
}
}
```
- In build.gradle.kts add the following:
```kotlin
dependencies {
implementation("io.mosip:tuvali:1.0-SNAPSHOT")
}
```
The kotlin library has been added to your project.

## Usage as a Swift library (for native ios)

- Download swift artifact (ios-tuvali-library) from the repository.
- Open your project in XCode.
- Goto File > Add Package Dependencies.
- Select Add Local option.
- Add the artifact folder.

The swift library has been added to your project.

## Usage as a React-Native wrapper
### Installing this library as a dependency
```bash
# Install latest version
npm install @mosip/tuvali
Expand Down
Loading