docs: ReadMe maintenance.

mathrunet · Jan 19, 2023 · 616c55e · 616c55e
1 parent 7fb713f
commit 616c55e
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 1 deletion.
diff --git a/packages/katana_ui/README.md b/packages/katana_ui/README.md
@@ -23,3 +23,45 @@
 [[YouTube]](https://www.youtube.com/c/mathrunetchannel) | [[Packages]](https://pub.dev/publishers/mathru.net/packages) | [[Twitter]](https://twitter.com/mathru) | [[LinkedIn]](https://www.linkedin.com/in/mathrunet/)
 
 ---
+
+This package is a collection of additional features around the UI available in the Katana/Masamune framework.
+
+# Installation
+
+Import the following packages
+
+```dart
+flutter pub add katana_ui
+```
+
+# How to use
+
+## Modal dialog
+
+Alert and confirmation dialogs can be displayed.
+
+```dart
+// Alert dialog.
+Modal.alert(
+  title: "Title",
+  text: "Contents text",
+  submitText: "OK",
+  onSubmit: () {
+    // Processing when the OK button is pressed
+  },
+);
+
+// Confirmation dialog.
+Modal.confirm(
+  title: "Title",
+  text: "Contents text",
+  submitText: "Yes",
+  cancelText: "No",
+  onSubmit: () {
+    // Processing when the Yes button is pressed    
+  },
+  onCancel: () {
+    // Processing when the No button is pressed
+  }
+);
+```
diff --git a/packages/katana_ui/pubspec.lock b/packages/katana_ui/pubspec.lock
@@ -122,7 +122,7 @@ packages:
       name: katana
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.15.10+1"
+    version: "0.15.10+2"
   matcher:
     dependency: transitive
     description: