Update README#104
Conversation
42e6dd3 to
a25f0f8
Compare
There was a problem hiding this comment.
Pull Request Overview
Updates the README to rebrand from “Formo Analytics SDK” to “Formo Web SDK,” enhance the header layout, and expand documentation with installation, methodology, and contributing sections
- Revised title, header alignment, and link badges
- Added detailed installation targets and methodology overview
- Introduced a contributing section with a link to guidelines
Comments suppressed due to low confidence (1)
README.md:35
- The sentence is incomplete; consider finishing the phrase (e.g., 'Feel free to open a pull request or issue').
[Contributions](https://github.com/getformo/sdk/blob/main/CONTRIBUTING.md) are welcome! Feel free to open
| ## Installation | ||
|
|
||
| Please visit Formo's [Developer Docs](https://docs.formo.so) for detailed guides and installation instructions. | ||
| The Formo Web SDK is a Javascript library that allows you to track and analyze user interactions on your dapp. |
There was a problem hiding this comment.
The term 'Javascript' should be spelled 'JavaScript' to match the official casing.
| The Formo Web SDK is a Javascript library that allows you to track and analyze user interactions on your dapp. | |
| The Formo Web SDK is a JavaScript library that allows you to track and analyze user interactions on your dapp. |
| <p align="center"> | ||
| <h1 align="center"><b>Formo Web SDK</b></h1> | ||
| <p align="center"> | ||
| Unified analytics for onchain apps. | ||
| <br /> | ||
| <a href="https://formo.so">Website</a> | ||
| · | ||
| <a href="https://docs.formo.so">Docs</a> | ||
| · | ||
| <a href="https://app.formo.so">Dashboard</a> | ||
| · | ||
| <a href="https://formo.so/slack">Slack</a> | ||
| · | ||
| <a href="https://twitter.com/getformo">X</a> | ||
| </p> | ||
| </p> | ||
|
|
There was a problem hiding this comment.
[nitpick] Using raw HTML for headings can reduce accessibility; consider using Markdown headings (e.g., '## Formo Web SDK') and CSS for centering.
| <p align="center"> | |
| <h1 align="center"><b>Formo Web SDK</b></h1> | |
| <p align="center"> | |
| Unified analytics for onchain apps. | |
| <br /> | |
| <a href="https://formo.so">Website</a> | |
| · | |
| <a href="https://docs.formo.so">Docs</a> | |
| · | |
| <a href="https://app.formo.so">Dashboard</a> | |
| · | |
| <a href="https://formo.so/slack">Slack</a> | |
| · | |
| <a href="https://twitter.com/getformo">X</a> | |
| </p> | |
| </p> | |
| ## Formo Web SDK | |
| Unified analytics for onchain apps. | |
| <a href="https://formo.so">Website</a> | |
| · | |
| <a href="https://docs.formo.so">Docs</a> | |
| · | |
| <a href="https://app.formo.so">Dashboard</a> | |
| · | |
| <a href="https://formo.so/slack">Slack</a> | |
| · | |
| <a href="https://twitter.com/getformo">X</a> |
There was a problem hiding this comment.
Bug: Incomplete Sentence in README
The "Contributing" section in README.md contains an incomplete sentence that abruptly ends with "Feel free to open". This appears to be accidentally committed unfinished content.
README.md#L34-L35
Lines 34 to 35 in cd9f82c
BugBot free trial expires on July 22, 2025
Learn more in the Cursor dashboard.
Was this report helpful? Give feedback by reacting with 👍 or 👎
|
🎉 This PR is included in version 1.19.3 🎉 |
Dependabot could not auto-fix these (transitive dev deps with no parent release bumping them), so pin via pnpm overrides — same pattern already used for picomatch/diff/hono: - serialize-javascript >=7.0.5 (was 6.0.2 via mocha): fixes RCE via RegExp.flags/Date.toISOString (#75) and CPU-exhaustion DoS (#103) - fast-uri >=3.1.2 (was 3.1.0 via webpack/ts-loader): fixes path traversal (#104) and host confusion (#105) Dev/build-only — not shipped in @formo/analytics. Full mocha suite passes (594/594) with the serialize-javascript 6->7 major bump. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Fix min release age units * Upgrade to pnpm 11 * chore: gitignore .claude/, drop invalid minReleaseAge key - Ignore .claude/ (local Claude Code settings + worktrees) so the nested repo copies are never committed. - Remove minReleaseAge: 2 from pnpm-workspace.yaml — not a valid pnpm key (silently ignored, leftover from old .npmrc). The active supply-chain cooldown remains minimumReleaseAge: 2880 (48h). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * security: override serialize-javascript & fast-uri to patched versions Dependabot could not auto-fix these (transitive dev deps with no parent release bumping them), so pin via pnpm overrides — same pattern already used for picomatch/diff/hono: - serialize-javascript >=7.0.5 (was 6.0.2 via mocha): fixes RCE via RegExp.flags/Date.toISOString (#75) and CPU-exhaustion DoS (#103) - fast-uri >=3.1.2 (was 3.1.0 via webpack/ts-loader): fixes path traversal (#104) and host confusion (#105) Dev/build-only — not shipped in @formo/analytics. Full mocha suite passes (594/594) with the serialize-javascript 6->7 major bump. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
No description provided.