Update README.md

README.md

@@ -1,2 +1,30 @@
 # logseq-publish-adjust-content-width
 A postprocessor for logseq-spa. Adjusts the width of the website content
+
+## Example Action
+```yaml
+on: [push]
+
+permissions:
+  contents: write
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Publish Logseq graph
+    steps:
+      - uses: actions/checkout@v3
+      - uses: logseq/publish-spa@main
+        with:
+          version: nightly
+          theme-mode: dark
+      - name: adjust content width
+        uses: Surferlul/logseq-publish-adjust-content-width@main
+        with:
+          content-width: 1000px
+      - name: add a nojekyll file # to make sure asset paths are correctly identified
+        run: touch $GITHUB_WORKSPACE/www/.nojekyll
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: www
+```