diff --git a/README.md b/README.md index 925dfae..12cde3f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,50 @@ -# About +# community.lexicon.* — Lexicon Community lexicons -This repository houses the `community.lexicon.*` NSID as part of the larger [ATProtocol](https://atproto.com/) lexicon ecosystem. +This repository is the canonical home of the `community.lexicon.*` lexicons: collectively +owned [AT Protocol](https://atproto.com/) schema definitions, stewarded by the +[Lexicon Community](https://lexicon.community/). Lexicons are the schema files that give AT +Protocol records their shape; this namespace exists so that shared, general-purpose schemas +don't have to live under any single company's name. -# Governance +The `main` branch is production: merged lexicons are published and resolvable on the AT +Protocol network. -See [lexicon-community/governance](https://github.com/lexicon-community/governance) +## Source of truth + +The source of truth for this repository is +[tangled.org/lexicon.community/lexicons](https://tangled.org/lexicon.community/lexicons). +The GitHub repository +([github.com/lexicon-community/lexicon](https://github.com/lexicon-community/lexicon)) is a +mirror. + +## What's here + +Lexicon JSON documents under `community/lexicon//`: + +| Namespace | Covers | +|-----------|--------| +| `app` | App profiles, listings, and localization | +| `bookmarks` | Bookmarks and bookmark queries | +| `calendar` | Calendar events and RSVPs | +| `interaction` | Generic interactions (likes) | +| `location` | Physical locations: addresses, coordinates, H3 cells, Foursquare POIs | +| `payments` | Web Monetization declaration | +| `preference` | User preferences on AI use of public data | + +## Website and documentation + +[lexicon.community](https://lexicon.community/) is the home for Lexicon Community +documentation and governance. Individual lexicons can be browsed on +[Lexicon Garden](https://lexicon.garden/), an independent lexicon browser and validator. + +## Governance and contributing + +Lexicon Community is a volunteer-run working group governed by a Technical Steering +Committee, with decisions made in the open. Proposals and discussion happen on the +[Lexicon Community forum](https://discourse.atmosphere.community/c/lexicon-community/31) — +bring the lexicon you wish existed, and the application, SDK, or tool that would use it. + +## License + +[MIT](LICENSE) — copyright Lexicon Community. Every schema in this repository is free to +use, fork, and remix.