animated gif membrane demo

[predic8]

Summary by CodeRabbit

• Documentation
  • Added a demo GIF banner to the README for a quick visual of the API Gateway.
  • Fixed typos and naming in configuration (e.g., “matchs”→“matches”, “Custum”→“Custom”, “pathParm”→“pathParam”).
  • Updated example texts (health check “I'm good.”) and Groovy example messages for consistency.
  • Clarified template/plugin wording and JSON protection wording; no changes to code or public APIs.

[coderabbitai]

Walkthrough

Added an animated demo GIF banner to README.md and applied multiple editorial fixes across the README (typos, grammar, wording, and formatting). No code, configuration, or public API changes were made.

Changes

Cohort / File(s)

Change Summary

Docs: README updates README.md

Added an animated demo GIF banner (docs/images/api-gateway-demo.gif) and applied editorial updates: typo corrections (e.g., “matchs”→“matches”, “Custum”→“Custom”, “pathParm”→“pathParam”), contraction/grammar fixes (e.g., “I'am”→“I'm”), refined example wording (Groovy snippets, health check text, Transform/JSON protection sections), and minor formatting/spacing adjustments. No behavioral or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Readme examples minor #2030 — Overlapping documentation edits to README examples (Groovy/script examples and example paths).

Suggested reviewers

• russelmrcl
• bridgerdier

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "animated gif membrane demo" concisely reflects the primary change in the PR — adding an animated GIF demo/banner (docs/images/api-gateway-demo.gif) to the README — and is specific rather than vague or misleading. It is short and readable, so it meets the title checklist's goals.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

I found a GIF and gave it a hop,
Popped into README with a tiny thump-stop.
I fixed a typo, nudged a line just right,
Now docs blink merrier in soft GIF light. 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3dcc79 and 4d9efa8.

📒 Files selected for processing (1)

• README.md (7 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Automated tests
• GitHub Check: Analyze (java)

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch animated-gif-2

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

346-349: Fix user-facing typos/grammar in docs

Small wording issues reduce polish; suggest the edits below.

- | `method` | - HTTP method (e.g., `GET`, `POST`, `DELETE`).<br>- `*` matchs any method. |
- | `test` | - Custum script e.g. `$pathParm.id == '42'`, `$header.contentType == '...'`     |
+ | `method` | - HTTP method (e.g., `GET`, `POST`, `DELETE`).<br>- `*` matches any method. |
+ | `test` | - Custom script e.g. `$pathParam.id == '42'`, `$header.contentType == '...'`     |

-    <static>I'am fine.</static>
+    <static>I'm fine.</static>

-    println "I'am executed in the ${flow} flow" 
+    println "I'm executed in the ${flow} flow"

-            I'am executed in the REQUEST flow
+            I'm executed in the REQUEST flow
@@
-            I'am executed in the RESPONSE flow
+            I'm executed in the RESPONSE flow

-Then the properties are available as variables inside `template`.
-plugin.
+Then the properties are available as variables inside the `template` plugin.

-- **Object Size**: Maximum number of fields in aJSON object.
+- **Object Size**: Maximum number of fields in a JSON object.

Also applies to: 364-365, 437-454, 697-698, 1017-1018

🧹 Nitpick comments (1)

README.md (1)

8-10: Optimize README demo media for performance & accessibility

Verified docs/images/api-gateway-demo.gif exists (407,176 bytes ≈ 0.39 MB), is a real GIF (GIF89a), and .gitattributes contains no Git LFS entries.

File: README.md (lines 8–10)

• Add descriptive alt text and constrain display width to avoid layout shifts.
• Provide MP4/WebM alongside the GIF if you want smaller/faster playback (GIF size is small here, so optional).

-![API Gateway Demo](docs/images/api-gateway-demo.gif)
+<img src="docs/images/api-gateway-demo.gif"
+     alt="Animated demo of Membrane API Gateway (routing, admin console, request flow)"
+     width="800" />

Or:

-![API Gateway Demo](docs/images/api-gateway-demo.gif)
+<details>
+  <summary>API Gateway demo (click to view)</summary>
+  <img src="docs/images/api-gateway-demo.gif"
+       alt="Animated demo of Membrane API Gateway (routing, admin console, request flow)"
+       width="800" />
+  <p>Prefer video? <a href="docs/videos/api-gateway-demo.mp4">Watch MP4</a></p>
+</details>

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7c401d1 and 28db427.

⛔ Files ignored due to path filters (1)

• docs/images/api-gateway-demo.gif is excluded by !**/*.gif

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Automated tests
• GitHub Check: Analyze (java)