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.

Sign up for GitHub

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

Add pre-1.0 versioning warning in README #5

Merged
merged 2 commits into from
Feb 2, 2021
Merged

Add pre-1.0 versioning warning in README #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3bfa03
Add pre-1.0 versioning warning in README
arnellebalane Jan 27, 2021
6744b63
Rename repo and update links
arnellebalane Jan 27, 2021
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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to SmartScanner Android

Thank you for your interest to contribute to SmartScanner Android! We want to make contributing to this project as easy as possible, whether it's:
Thank you for your interest to contribute to SmartScanner Android API! We want to make contributing to this project as easy as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
Expand All @@ -23,7 +23,7 @@ All code changes happen through pull requests. Your pull requests to the codebas

## Reporting bugs

We use [GitHub issues](https://github.com/idpass/smartscanner-android/issues) to track bugs. Report a bug by [opening a new issue](https://github.com/idpass/smartscanner-android/issues/new).
We use [GitHub issues](https://github.com/idpass/smartscanner-android-api/issues) to track bugs. Report a bug by [opening a new issue](https://github.com/idpass/smartscanner-android-api/issues/new).

Write bug reports with detail, background, and sample code. An issue template is provided when opening a new issue, make sure to provide all the requested information to make it easier to address the issue.

Expand Down
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# SmartScanner Android
# SmartScanner Android API

Convenience API for [SmartScanner Core](https://github.com/idpass/smartscanner-core/) to simplify the Intent call out process.

This library provides methods that can be called to initiate scanning of MRZ, barcode, and [ID PASS Lite](https://github.com/idpass/idpass-lite) cards, instead of manually creating and calling intents.

**Note: The library's API might keep evolving before we reach v1.0, so be careful when upgrading between these pre-v1.0 versions. Starting at v1.0 we will be careful in introducing breaking API changes.**

## Installation

Declare Maven Central repository in the dependency configuration, then add this library in the dependencies. An example using `build.gradle`:
Expand All @@ -14,11 +16,11 @@ repositories {
}

dependencies {
implementation "org.idpass:smartscanner-android:0.0.1-SNAPSHOT"
implementation "org.idpass:smartscanner-android-api:0.0.1-SNAPSHOT"
}
```

If you want to build this library from source, instructions to do so can be found in the [Building from source](https://github.com/idpass/smartscanner-android/wiki/Building-from-source) wiki page.
If you want to build this library from source, instructions to do so can be found in the [Building from source](https://github.com/idpass/smartscanner-android-api/wiki/Building-from-source) wiki page.

## Usage

Expand Down Expand Up @@ -85,6 +87,12 @@ class MainActivity : AppCompatActivity() {

Provides [constant variables](app/src/main/java/org/idpass/smartscanner/api/ScannerConstants.kt) that can be used instead of hardcoded strings. We recommend using these constants when working with this library and [smartscanner-core](https://github.com/idpass/smartscanner-core/).

## Related projects

- [smartscanner-core](https://github.com/idpass/smartscanner-core) - Android library for scanning MRZ, Barcode, and ID PASS Lite cards
- [smartscanner-capacitor](https://github.com/idpass/smartscanner-capacitor) - SmartScanner [Capacitor](https://capacitorjs.com/) plugin
- [smartscanner-cordova](https://github.com/idpass/smartscanner-cordova) - SmartScanner [Cordova](https://cordova.apache.org/) plugin

## License

[Apache-2.0 License](LICENSE)
Expand Down