From ebbd7e8d32884e320e20a23088463f174cf86f67 Mon Sep 17 00:00:00 2001 From: Anirudh Oppiliappan Date: Mon, 20 Jul 2026 18:30:18 +0300 Subject: [PATCH] readme.md: rewrite Signed-off-by: Anirudh Oppiliappan --- readme.md | 50 +++++++++++++++++++++++++++++++++++++------------- 1 file changed, 37 insertions(+), 13 deletions(-) diff --git a/readme.md b/readme.md index dbddb50e..cceca904 100644 --- a/readme.md +++ b/readme.md @@ -1,20 +1,44 @@ -# tangled +# Tangled -Hello Tanglers! This is the codebase for -[Tangled](https://tangled.org)—a code collaboration platform built -on the [AT Protocol](https://atproto.com). +https://tangled.org -Read the introduction to Tangled [here](https://blog.tangled.org/intro). Join the -[Discord](https://chat.tangled.org) or IRC at [#tangled on -libera.chat](https://web.libera.chat/#tangled). +The next-generation social coding platform. -## docs +## Overview -- [knot hosting guide](https://docs.tangled.org/knot-self-hosting-guide.html#knot-self-hosting-guide) -- [contributing guide](https://docs.tangled.org/contribution-guide.html#contribution-guide) **please read before opening a PR!** -- [hacking on tangled](https://docs.tangled.org/hacking-on-tangled.html#hacking-on-tangled) +This monorepo contains the majority of Tangled's open source code. Notably, it +includes: -## security +* the primary [appview](https://tangled.org/tangled.org/core/tree/master/appview) service, +* [knotserver](https://tangled.org/tangled.org/core/tree/master/knotserver) for git hosting and operations, +* [spindle](https://tangled.org/tangled.org/core/tree/master/spindle) for continuous integration, +* [bobbin](https://tangled.org/tangled.org/core/tree/master/bobbin), the API service, + +... and more. + +## Bugs + +Please file any issues about this code or the hosted service on the [issue +tracker](https://tangled.org/tangled.org/core/issues). You may also use our +[Discord](https://chat.tangled.org) for the same. + +## Security If you've identified a security issue in Tangled, please email -[security@tangled.org](mailto:security@tangled.org) with details! +[security@tangled.org](mailto:security@tangled.org) with the details! + +## Contributing + +PRs welcome! But please file a [proposal for bigger +changes](https://docs.tangled.org/contribution-guide#proposals-for-bigger-changes). +We have strict [rules for commit +messages](https://docs.tangled.org/contribution-guide#commit-guidelines) (or +skim `git log`). + +We require a Developer Certificate of Origin (DCO) `Signed-off-by:` line in +commits. [Read more +here](https://docs.tangled.org/contribution-guide#developer-certificate-of-origin-dco). + +## Legal + +The contents of this repository are licensed under MIT. -- 2.51.2