Update README

gitignore-in · Oct 7, 2023 · c886fb7 · c886fb7
1 parent b267a13
commit c886fb7
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,24 @@
 # GitHub Action for gitignore-in
 
-WIP
+gitignore-in is a tool to generate .gitignore files from templates.
+This action runs gitignore-in and commits the result to the repository.
+
+## Example
+
+.gitignore.in is a template file for gitignore-in. And this works as ordinary shell script.
+
+```bash
+gibo dump macOS
+gibo dump Windows
+echo "node_modules/"
+```
+
+```
+$ gitignore-in
+Generated .gitignore
+```
+
+If the .gitignore.in is changed, the action will create pull request automatically.
 
 ## Usage