docs: update readme

K9i-0 · May 3, 2023 · d20a9a5 · d20a9a5
1 parent 37a5725
commit d20a9a5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/packages/material_button_assist/README.md b/packages/material_button_assist/README.md
@@ -1,6 +1,11 @@
-# material_button_assist
 material_button_assist is an assistant that makes using [Common buttons] easier.
 
+- [Getting started](#getting-started)
+- [Features](#features)
+  - [Convert to other button](#convert-to-other-button)
+  - [Add icon](#add-icon)
+  - [Remove icon](#remove-icon)
+
 ## Getting started
 
 material_button_assist is implemented using [custom_lint]. As such, it uses custom_lint's installation logic.
@@ -24,6 +29,19 @@ Long story short:
 ## Features
 
 
+### Convert to other button
+You can easily convert between five different buttons.
+- Elevated button
+- Filled button
+- Filled tonal button
+- Outlined button
+- Text button
+
+### Add icon
+Add icons to the buttons and automatically update the field names as well.
+
+### Remove icon
+Remove icons from the buttons and automatically update the field names as well.
 
 [Common buttons]: https://m3.material.io/components/buttons/overview
 [custom_lint]: https://pub.dev/packages/custom_lint
diff --git a/packages/material_button_assist/example/README.md b/packages/material_button_assist/example/README.md
@@ -1,3 +1,3 @@
 # example
 
-A new Flutter project.
+material_button_assist example project.