Skip to content

Commit ef9d19e

Browse files
Debanitrklclaude
andcommitted
docs: add Parseable Cloud CTA, adopters section, and auto-sync workflow
- Update README description to link Parseable Cloud (app.parseable.com) - Add centered Cloud CTA block before YouTube embed - Add Adopters section (between Features and Verify Images) with ADOPTERS:START/END markers, sourced from USERS.md - Add GitHub Action to auto-sync adopters from USERS.md to README on push to main Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f7b01e3 commit ef9d19e

2 files changed

Lines changed: 87 additions & 1 deletion

File tree

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Sync Adopters to README
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths: [USERS.md]
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
sync:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Extract adopters and update README
18+
run: |
19+
python3 - <<'SCRIPT'
20+
import re
21+
22+
# Read USERS.md and extract Organization + Description columns
23+
with open("USERS.md") as f:
24+
lines = f.read().strip().split("\n")
25+
26+
rows = []
27+
for line in lines:
28+
if not line.startswith("|"):
29+
continue
30+
parts = [p.strip() for p in line.split("|")]
31+
# parts: ['', org, contact, desc, '']
32+
if len(parts) < 4:
33+
continue
34+
org = parts[1]
35+
if org == "Organization" or org.startswith("---") or org.startswith("--"):
36+
continue
37+
desc = parts[3]
38+
rows.append(f"| {org} | {desc} |")
39+
40+
table = "| Organization | Description of Use |\n| --- | --- |\n" + "\n".join(rows)
41+
42+
# Replace content between markers in README.md
43+
with open("README.md") as f:
44+
readme = f.read()
45+
46+
readme = re.sub(
47+
r"(<!-- ADOPTERS:START -->\n).*?(\n<!-- ADOPTERS:END -->)",
48+
rf"\g<1>{table}\g<2>",
49+
readme,
50+
flags=re.DOTALL,
51+
)
52+
53+
with open("README.md", "w") as f:
54+
f.write(readme)
55+
SCRIPT
56+
57+
- name: Check for changes
58+
id: diff
59+
run: git diff --quiet README.md || echo "changed=true" >> "$GITHUB_OUTPUT"
60+
61+
- name: Commit and push
62+
if: steps.diff.outputs.changed == 'true'
63+
run: |
64+
git config user.name "github-actions[bot]"
65+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
66+
git add README.md
67+
git commit -m "docs: sync adopters from USERS.md to README"
68+
git push

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@
1717

1818
</div>
1919

20-
Parseable is a full stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or as a managed service. To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login).
20+
Parseable is a full stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or use [Parseable Cloud](https://app.parseable.com) — the fully managed service. To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login).
21+
22+
<div align="center">
23+
<h3>
24+
<a href="https://app.parseable.com">Try Parseable Cloud — Start Free ↗︎</a>
25+
</h3>
26+
<p><i>The fastest way to get started. No infrastructure to manage.</i></p>
27+
</div>
2128

2229
<div align="center">
2330
<a href="http://www.youtube.com/watch?feature=player_embedded&v=gYn3pFAfrVA" target="_blank">
@@ -103,6 +110,17 @@ This section elaborates available options to run Parseable in production or deve
103110
- [OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid)
104111
- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/OpenTelemetry/logs)
105112

113+
## Adopters :handshake:
114+
115+
Organizations using Parseable in production. Add yours by submitting a PR to [USERS.md](USERS.md).
116+
117+
<!-- ADOPTERS:START -->
118+
| Organization | Description of Use |
119+
| --- | --- |
120+
| [HireXL](https://www.hirexl.in/) | Frontend application logging |
121+
| [Elfsquad](https://elfsquad.io) | Centralized application/infrastructure logging |
122+
<!-- ADOPTERS:END -->
123+
106124
## Verify images :writing_hand:
107125

108126
Parseable builds are attested for build provenance and integrity using the [attest-build-provenance](https://github.com/actions/attest-build-provenance) action. The attestations can be verified by having the latest version of [GitHub CLI](https://github.com/cli/cli/releases/latest) installed in your system. Then, execute the following command:

0 commit comments

Comments
 (0)