From ab5f7cec16a32ba04d9316690652771fc6dc6515 Mon Sep 17 00:00:00 2001
From: "Tomachi [ICHIGO]" <lego@aol.jp>
Date: Fri, 17 Dec 2021 20:12:33 +0900
Subject: [PATCH] feat: readme

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..68acc8b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# pom.xml Dependencies Updater (pomxml-dep-update)
+
+If there is a newer version of the dependency in pom.xml, rewrite it to the latest version.
+
+## Attention
+
+This action may cause destructive changes to the existing file (`pom.xml`).
+
+## Action Inputs
+
+- `pom-path`: Path to `pom.xml` (e.g, `pom.xml`)
+- `ignore-packages`: The packages that will not be updated, Comma separated (e.g, `com.tomacheese.abc,com.tomacheese.def`)
+
+## Example
+
+```yml
+- name: pom.xml Dependencies Updater
+  uses: book000/pomxml-dep-update@v1.0.0
+  with:
+    pom-path: pom.xml
+    ignore-packages: com.tomacheese.abc,com.tomacheese.def
+```