Skip to content

Commit c5a024b

Browse files
committed
README file maintenance
What is done here: For every method mentioned added link; Remove git from installation instructions; Fix wrong link for registration
1 parent 9d49ce9 commit c5a024b

File tree

1 file changed

+34
-17
lines changed

1 file changed

+34
-17
lines changed

README.md

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ Add flutter_miracl_sdk to `pubspec.yaml`:
2424

2525
```yaml
2626
dependencies:
27-
flutter_miracl_sdk:
28-
git:
29-
url: https://github.com/miracl/trust-sdk-flutter-wrapper
27+
flutter_miracl_sdk: ^0.5.2
3028
```
3129
3230
## Usage
@@ -103,7 +101,8 @@ offers two options for that:
103101
(default)
104102
- [Email Code](https://miracl.com/resources/docs/guides/built-in-user-verification/email-code/)
105103

106-
Start the verification by calling the `sendVerificationEmail`
104+
Start the verification by calling the
105+
[sendVerificationEmail](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/sendVerificationEmail.html)
107106
method:
108107

109108
```dart
@@ -115,7 +114,7 @@ offers two options for that:
115114
```
116115

117116
Then, a verification email is sent, and a
118-
`EmailVerificationResponse`
117+
[EmailVerificationResponse](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/EmailVerificationResponse-class.html)
119118
with backoff and email verification method is returned.
120119

121120
If the verification method you have chosen for your project is:
@@ -151,7 +150,9 @@ different ways, depending on the type of verification.
151150
or [Email Link](https://miracl.com/resources/docs/guides/built-in-user-verification/email-link/):
152151

153152
After the application recieves the Verification URL, it must confirm the
154-
verification by passing it to the `getActivationTokenByURI` method:
153+
verification by passing it to the
154+
[getActivationTokenByURI](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/getActivationTokenByURI.html)
155+
method:
155156

156157
```dart
157158
try {
@@ -165,7 +166,7 @@ different ways, depending on the type of verification.
165166

166167
When the end user enters the verification code, the application must
167168
confirm the verification by passing it to the
168-
`getActivationTokenByUserIdAndCode`
169+
[getActivationTokenByUserIdAndCode](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/getActivationTokenByUserIdAndCode.html)
169170
method:
170171

171172
```dart
@@ -178,7 +179,8 @@ different ways, depending on the type of verification.
178179
```
179180

180181
2. Pass the User ID (email or any string you use for identification), activation
181-
token (received from verification) and the user-entered PIN code to the `register`
182+
token (received from verification) and the user-entered PIN code to the
183+
[register](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/register.html)
182184
method:
183185

184186
```dart
@@ -193,7 +195,9 @@ different ways, depending on the type of verification.
193195
}
194196
```
195197

196-
If you call the `register` method with the same User ID more
198+
If you call the
199+
[register](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/register.html)
200+
method with the same User ID more
197201
than once, the User ID will be overridden. Therefore, you can
198202
use it to reset your authentication PIN code.
199203

@@ -206,7 +210,9 @@ The MIRACL Trust SDK offers two options:
206210

207211
#### Authenticate users on the mobile application
208212

209-
The `authenticate` method generates a [JWT](https://jwt.io) authentication
213+
The
214+
[authenticate](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/authenticate.html)
215+
method generates a [JWT](https://jwt.io) authentication
210216
token for а registered user.
211217

212218
```dart
@@ -230,7 +236,9 @@ There are three options for authenticating a user on another application:
230236

231237
- Authenticate with deep link:
232238

233-
Use the `authenticateWithLink` method:
239+
Use the
240+
[authenticateWithLink](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/authenticateWithLink.html)
241+
method:
234242

235243
```dart
236244
try {
@@ -244,7 +252,9 @@ There are three options for authenticating a user on another application:
244252

245253
- Authenticate with a QR code
246254

247-
Use the `authenticateWithQrCode` method:
255+
Use the
256+
[authenticateWithQRCode](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/authenticateWithQRCode.html)
257+
method:
248258

249259
```dart
250260
try {
@@ -256,7 +266,8 @@ There are three options for authenticating a user on another application:
256266

257267
- Authenticate with push notifications payload:
258268

259-
Use the `authenticateWithNotificationPayload`:
269+
Use the
270+
[authenticateWithNotificationPayload](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/authenticateWithNotificationPayload.html):
260271

261272
```dart
262273
try {
@@ -276,7 +287,9 @@ cryptographic signing of documents. For more information, see
276287
[Designated Verifier Signature](https://miracl.com/resources/docs/concepts/dvs/).
277288
In the context of this plugin, we refer to it as 'Signing'.
278289

279-
To sign a document, use the `sign` method as follows:
290+
To sign a document, use the
291+
[sign](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/sign.html)
292+
method as follows:
280293

281294
```dart
282295
try {
@@ -297,8 +310,12 @@ entry in the response body indicates that the signing is successful.
297310
[QuickCode](https://miracl.com/resources/docs/guides/built-in-user-verification/quickcode/)
298311
is a way to register another device without going through the verification process.
299312

300-
To generate a QuickCode, call the `generateQuickCode` method with
301-
an already registered `User` object:
313+
To generate a QuickCode, call the
314+
[generateQuickCode](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/generateQuickCode.html)
315+
method with
316+
an already registered
317+
[User](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/User-class.html)
318+
object:
302319

303320
```dart
304321
try {
@@ -315,7 +332,7 @@ try {
315332
Activation Token is the value that links the verification flow with the
316333
registration flow. The value is returned by the verification flow and needs
317334
to be passed to the
318-
[register](https://miracl.com/resources/docs/apis-and-libraries/ios/classes/MIRACLTrust/#registerforactivationtokenpushnotificationstokendidrequestpinhandlercompletionhandler)
335+
[register](https://pub.dev/documentation/flutter_miracl_sdk/latest/flutter_miracl_sdk/MIRACLTrust/register.html)
319336
method so the platform can verify it. Here are the options for that:
320337

321338
- [Custom User Verification](https://miracl.com/resources/docs/guides/custom-user-verification/)

0 commit comments

Comments
 (0)