From 8bea481f1a633633b2ce779b2a54ec4e799db41f Mon Sep 17 00:00:00 2001 From: Bhoomi070 Date: Fri, 31 Oct 2025 17:29:58 +0530 Subject: [PATCH] Refactor README for better readability and onboarding Use this for the detailed body of the commit message or the Pull Request description --- README.md | 72 +++++++++++++++++++------------------------------------ 1 file changed, 25 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index de7ac422d9f4..b1908523568b 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,33 @@ # AMP ⚡ - ⚡⚡⚡ -[![Build Status](https://img.shields.io/circleci/build/github/ampproject/amphtml/main 'Build Status')](https://app.circleci.com/pipelines/github/ampproject/amphtml?branch=main) -[![GitHub Release](https://img.shields.io/github/release/ampproject/amphtml.svg?logo=GitHub&style=flat-square 'GitHub Release')](https://github.com/ampproject/amphtml/releases/latest) -[![Commits](https://img.shields.io/github/commit-activity/m/ampproject/amphtml.svg?logo=GitHub&style=flat-square 'Commits')](https://github.com/ampproject/amphtml/pulse/monthly) +Build Status GitHub Release Commits -
- Tooling - - - -[![Percy](https://img.shields.io/badge/%F0%9F%A6%94%20visual%20testing-Percy-violet.svg?style=flat-square 'Percy')](https://percy.io/ampproject/amphtml) -[![Prettier](https://img.shields.io/badge/code_style-Prettier-ff69b4.svg?logo=Prettier&logoColor=white&style=flat-square 'Prettier')](https://github.com/prettier/prettier) -[![Codecov](https://img.shields.io/badge/test_coverage-CodeCov-f01f7a.svg?logo=Codecov&logoColor=white&style=flat-square 'Codecov')](https://codecov.io/gh/ampproject/amphtml/) -[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=dependabot&style=flat-square 'Renovate')](https://renovateapp.com/) - -
- -[AMP](https://amp.dev) is a web component framework for easily creating user-first websites, stories, ads, emails and more. +AMP is a web component framework for easily creating user-first websites, stories, ads, emails and more. AMP is an open source project, and we'd love your help making it better! -## Want to know more about AMP? - -- [amp.dev](https://amp.dev) is the best place to learn more about AMP--and of course the site is made using AMP! -- For developers using AMP, amp.dev includes - - [guides and tutorials](https://amp.dev/documentation/guides-and-tutorials/) - - [examples](https://amp.dev/documentation/examples/) - - [reference docs](https://amp.dev/documentation/components/?format=websites) - - [example templates](https://amp.dev/documentation/templates/) - - [tools to make using AMP easier](https://amp.dev/documentation/tools) - -## Having a problem using AMP? - -- The [amp.dev Support page](https://amp.dev/support/) has resources for getting help. -- Use [Stack Overflow](http://stackoverflow.com/questions/tagged/amp-html) to ask questions about using AMP and find answers to questions others have asked. -- [Let us know about bugs](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#report-a-bug), and [file feature requests](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#make-a-suggestion) to suggest improvements. -- AMP accepts responsible security disclosures through the [Google Application Security program](https://www.google.com/about/appsecurity/). - -## Want to help make AMP better? - -- [docs/contributing.md](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md) has information on how you can help improve AMP, including [ongoing participation](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#ongoing-participation) through Slack, weekly design reviews, etc. -- We strongly encourage [code contributions](https://github.com/ampproject/amphtml/blob/main/docs/contributing-code.md)! -- **We enthusiastically welcome new contributors to AMP _even if you have no experience being part of an open source project_**. We've made it easy to [get started contributing](https://github.com/ampproject/amphtml/blob/main/docs/contributing.md#get-started-with-open-source). -- Consider joining one of AMP's [Working Groups](https://github.com/ampproject/meta/tree/main/working-groups), where most of the day-to-day work in AMP gets done. - -## Other useful information - -- [AMP's release documentation](docs/release-schedule.md) provides details on how and when AMP releases new versions, including [how to know when a change is live in a release](https://github.com/ampproject/amphtml/blob/main/docs/release-schedule.md#determining-if-your-change-is-in-a-release). -- [AMP's roadmap](https://amp.dev/community/roadmap) provides details on some of the significant projects we are working on. -- The [AMP meta repository](https://github.com/ampproject/meta) has information _about_ the AMP open source project, including AMP's [governance](https://github.com/ampproject/meta/blob/main/GOVERNANCE.md). -- [AMP's code of conduct](https://github.com/ampproject/meta/blob/main/CODE_OF_CONDUCT.md) documents how all members, committers and volunteers in the community are required to act. AMP strives for a positive and growing project community that provides a safe environment for everyone. +Want to know more about AMP? +amp.dev is the best place to learn more about AMP--and of course the site is made using AMP! +For developers using AMP, amp.dev includes +guides and tutorials +examples +reference docs +example templates +tools to make using AMP easier +Having a problem using AMP? +The amp.dev Support page has resources for getting help. +Use Stack Overflow to ask questions about using AMP and find answers to questions others have asked. +Let us know about bugs, and file feature requests to suggest improvements. +AMP accepts responsible security disclosures through the Google Application Security program. +Want to help make AMP better? +docs/contributing.md has information on how you can help improve AMP, including ongoing participation through Slack, weekly design reviews, etc. +We strongly encourage code contributions! +We enthusiastically welcome new contributors to AMP even if you have no experience being part of an open source project. We've made it easy to get started contributing. +Consider joining one of AMP's Working Groups, where most of the day-to-day work in AMP gets done. +Other useful information +AMP's release documentation provides details on how and when AMP releases new versions, including how to know when a change is live in a release. +AMP's roadmap provides details on some of the significant projects we are working on. +The AMP meta repository has information about the AMP open source project, including AMP's governance. +AMP's code of conduct documents how all members, committers and volunteers in the community are required to act. AMP strives for a positive and growing project community that provides a safe environment for everyone.