Skip to content

Commit

Permalink
Rename repo and update links
Browse files Browse the repository at this point in the history
  • Loading branch information
arnellebalane authored and rjmangubat23 committed Feb 2, 2021
1 parent b108b2e commit d06c39a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
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
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SmartScanner Android
# SmartScanner Android API

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

Expand All @@ -16,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 @@ -87,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

0 comments on commit d06c39a

Please sign in to comment.