From 5cf1bf913a4ca86230775a18d29390a135044dd1 Mon Sep 17 00:00:00 2001 From: devs6186 Date: Thu, 19 Feb 2026 21:56:13 +0530 Subject: [PATCH] [docs] Trim README "What is Augur?" to a short summary with a readthedocs link The section was duplicating content that already lives in readthedocs. Replaced it with a 2-sentence summary and a pointer to the full docs. Fixes #3703 Signed-off-by: devs6186 --- README.md | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/README.md b/README.md index cbab2232c3..e5d0023057 100644 --- a/README.md +++ b/README.md @@ -26,20 +26,7 @@ Augur is now releasing a dramatically improved new version. It is also available If the hosted instance already has a requested organization or repository it will be added to a user’s view. If its a new repository or organization, the user will be notified that collection will take (time required for the scale of repositories added). ## What is Augur? -Augur is a software suite for collecting and measuring structured data -about [free](https://www.fsf.org/about/) and [open-source](https://opensource.org/docs/osd) software (FOSS) communities. - -We gather trace data for a group of repositories, normalize it into our data model, and provide a variety of metrics about said data. The structure of our data model enables us to synthesize data across various platforms to provide meaningful context for meaningful questions about the way these communities evolve. - -Augur’s main focus is to measure the overall health and sustainability of open source projects, as these types of projects are system critical for nearly every software organization or company. We do this by gathering data about project repositories and normalizing that into our data model to provide useful metrics about your project’s health. - -For example, one of our metrics is *burstiness*. Burstiness – how are short timeframes of intense activity, followed by a corresponding return to a typical pattern of activity, observed in a project? -This can paint a picture of a project’s focus and gain insight into the potential stability of a project and how its typical cycle of updates occurs. - -We are a [CHAOSS](https://chaoss.community) project, and many of our -metrics are implementations of the metrics defined by our awesome community. You can find a full list of them [here](https://chaoss.community/metrics/). - -For more information on [how to get involved on the CHAOSS website](https://chaoss.community/participate/). +Augur is a software suite for collecting and measuring structured data about free and open-source software (FOSS) communities. It gathers data from Git logs, GitHub, and other sources, normalizes it into a shared data model, and exposes health and sustainability metrics via a REST API. For a full overview, see the [Augur documentation](https://oss-augur.readthedocs.io/en/main/). ## Collecting Data