見出し画像

パッケージを自作してみる⑥(実装編⑤)

こんにちは、株式会社Pentagonでアプリ開発をしている石渡港です。

https://pentagon.tokyo

前回

今日は、Flutterのパッケージを自作してみる⑤(実装編④) について簡単にまとめたいと思います。

今回はREADME.mdの更新を記載いたします。

■ README.mdを整備する

まずはソースを記載

# ptg_ripple_effect

This package is easy to use the ripple effect.

## Getting Started

```yaml
ptg_ripple_effect: ^0.0.2
```

install to [here](https://pub.dev/packages/ptg_ripple_effect)

## Usage

```dart
...
       RippleEffect(
             child: Colum(
               children: [
                 Text('tap'),
                 Text('here'),
               ],
             ),
             onTap: () {
               // TODO: api call
             },
           );
...
```

ptg_ripple_effectの下の行
概要の説明を記載します。

Getting Started
導入方法の説明を記載します。

Usage
使い方を記載します。

次回はexampleの追加方法を説明します🙋

この記事が気に入ったらサポートをしてみませんか?