8000 update README · nextcloud-deps/hwsecurity@5f09768 · GitHub
[go: up one dir, main page]

Skip to content

Commit 5f09768

Browse files
committed
update README
1 parent 7269955 commit 5f09768

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
# Hardware Security SDK
22

3-
## An SDK for Supporting Security Keys and Smartcards on Android
3+
An SDK for supporting security keys and smartcards on Android.
4+
Use cases include:
5+
* WebAuthn/FIDO2 passwordless logins
6+
* FIDO U2F Two-Factor Authentication
7+
* SSH Authentication using OpenPGP/PIV cards
8+
* Personal Identity Verification (PIV)
9+
* Full app database encryption using external hardware
410

5-
Code examples and documentation can be found on our [developer page](https://hwsecurity.dev/docs/).
11+
## Documentation
612

7-
## Open Source Release
13+
Code examples and documentation can be found on our developer page at [hwsecurity.dev/docs](https://hwsecurity.dev/docs/).
14+
15+
## Open Source
816

917
This repository contains all parts of the Hardware Security SDK that have been released as open source.
1018

@@ -27,16 +35,25 @@ This includes the following artifacts of the SDK (cf. [overview of all artifacts
2735
This open source release does not reflect the newest version of the SDK.
2836
Some parts are currently not released as GPLv3.
2937

38+
## Maven/NuGet Repositories
39+
40+
For paying customers, we provide an official Maven and NuGet repository:
41+
* [Documentation for Maven](https://hwsecurity.dev/docs/sdk/)
42+
* [Documentation for NuGet](https://hwsecurity.dev/xamarin/xamarin-sdk/)
43+
44+
There is also an unofficial Maven repository for open source projects using the SDK under GPLv3:
45+
* https://jitpack.io/#cotechde/hwsecurity/
46+
3047
## Contributing
3148

3249
Hardware Security SDK is an open source project and we are very happy to accept community contributions.
3350

3451
We will ask you to sign our [CLA](https://cla-assistant.io/cotechde/hwsecurity) before your pull request can be merged.
3552

36-
## Licensing
37-
38-
You can use our SDK under the terms of the GNU General Public license version 3 or later.
53+
## Commercial License
3954

4055
A commercial license can be purchased on [hwsecurity.dev/sales](https://hwsecurity.dev/sales/).
4156

4257
Buying such a license is mandatory as soon as you develop commercial activities involving this program without disclosing the source code of your own applications.
58+
59+
You can use our SDK under the terms of the GNU General Public license version 3 or later.

0 commit comments

Comments
 (0)
0