added v1

README.md

@@ -1 +1,32 @@
-# action-cleanup
+# Cleanup Workspace - Github Action
+
+Simply removes all files from the root directory.
+
+This is useful to clean residue in workspaces
+from previous self-hosted builds which can have a mix of root owned
+files that are not able to be removed by the user running the action.
+
+It seems the checkout action is run as the host user, but files created by other
+actions is run by root.  The subsequent checkout is unable to remove the files
+created from the previous run.  Action Runners does not automatically clean up.
+
+This action can also be used in the end of workflow to clear all files
+and free up diskspace in self-hosted runner.
+
+## Usage
+
+```yml
+name: Build with Cleanup
+
+on:
+  push:
+    branches-ignore:
+      - master
+jobs:
+  build:
+    runs-on: self-hosted
+    steps:
+      - uses: asilbek99/action-cleanup@v1
+      - uses: actions/checkout@v3
+      - run: echo Hello World
+```