Add basic README, update name, add gitignore.

carlosperate · Jan 30, 2023 · bb8beba · bb8beba
1 parent ce55f6f
commit bb8beba
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,33 @@
+####################
+# Project specific #
+####################
+# Nothing yet
+
+######################
+# OS generated files #
+######################
+# macoOS
+.DS_Store
+.DS_Store?
+.AppleDouble
+.LSOverride
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+
+# Windows
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+*.stackdump
+[Dd]esktop.ini
+$RECYCLE.BIN/
+*.lnk
+
+# Linux
+*~
+.fuse_hidden*
+.directory
+.Trash-*
+.nfs*
diff --git a/README.md b/README.md
@@ -1,2 +1,19 @@
-# bloaty-action
+# Bloaty McBloatface GitHub Action
+
 GitHub Action to run Bloaty McBloatface: a size profiler for binaries 
+
+```yaml
+- name: Run Bloaty McBloatface on an ELF file
+  uses: carlosperate/bloaty-action@v0
+  with:
+    bloaty-args: tests/test-elf-files/example-before.elf
+```
+
+
+## Using the base Docker Image to run Bloaty McBloatface locally
+
+To diff two ELF files (from the project root directory):
+
+```
+docker run --rm -v $(pwd):/home ghcr.io/carlosperate/bloaty:latest tests/test-elf-files/example-before.elf -- tests/test-elf-files/example-after.elf
+```
diff --git a/action.yml b/action.yml
@@ -1,4 +1,4 @@
-name: bloaty
+name: bloaty-action
 description: "GitHub Action to run Bloaty McBloatface: a size profiler for binaries"
 author: Carlos Pereira Atencio
 branding: