about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2023-10-06 08:45:41 -0700
committerGitHub <noreply@github.com>2023-10-06 08:45:41 -0700
commit34f9d12987e58f2a62b36574faea3fb6ad948d68 (patch)
treee12211d58c0799757697f521e26a542a28811066 /README.md
parentd2f11f8e3650be601528aad0ba2c7beed307999f (diff)
downloadvoidsky-34f9d12987e58f2a62b36574faea3fb6ad948d68.tar.zst
README: tweaks to high-level context (#1625)
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 18 insertions, 9 deletions
diff --git a/README.md b/README.md
index c32d726e4..08e7aba28 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,33 @@
 # Bluesky Social App
 
-Welcome friends! This is the codebase for the Bluesky Social app. It serves as a resource to engineers building on the [AT Protocol](https://atproto.com).
+Welcome friends! This is the codebase for the Bluesky Social app.
+
+Get the app itself:
 
 - **Web: [bsky.app](https://bsky.app)**
 - **iOS: [App Store](https://apps.apple.com/us/app/bluesky-social/id6444370199)**
 - **Android: [Play Store](https://play.google.com/store/apps/details?id=xyz.blueskyweb.app&hl=en_US&gl=US)**
 
-Links:
+## Development Resources
+
+This is a [React Native](https://reactnative.dev/) application, written in the TypeScript programming language. It builds on the `atproto` TypeScript packages (like [`@atproto/api`](https://www.npmjs.com/package/@atproto/api)), code for which is also on open source, but in [a different git repository](https://github.com/bluesky-social/atproto).
+
+There is a small about of Go language source code (in `./bskyweb/`), for a web service that returns the React Native Web application.
+
+The [Build Instructions](./docs/builds.md) are a good place to get started with the app itself.
 
-- [Build instructions](./docs/build.md)
-- [ATProto repo](https://github.com/bluesky-social/atproto)
-- [ATProto docs](https://atproto.com)
+The Authenticated Transfer Protocol ("AT Protocol" or "atproto") is a decentralized social media protocol. You don't *need* to understand AT Protocol to work with this application, but it can help. Learn more at:
 
-## Rules & guidelines
+- [Overview and Guides](https://atproto.com/guides/overview)
+- [Github Discussions](https://github.com/bluesky-social/atproto/discussions) 👈 Great place to ask questions
+- [Protocol Specifications](https://atproto.com/specs/atp)
+- [Blogpost on self-authenticating data structures](https://blueskyweb.xyz/blog/3-6-2022-a-self-authenticating-social-protocol)
 
---- 
+The Bluesky Social application encompases a set of schemas and APIs built in the overall AT Protocol framework. The namespace for these "Lexicons" is `app.bsky.*`.
 
-â„šī¸ While we do accept contributions, we prioritize high quality issues and pull requests. Adhering to the below guidelines will ensure a more timely review.
+## Contributions
 
----
+> While we do accept contributions, we prioritize high quality issues and pull requests. Adhering to the below guidelines will ensure a more timely review.
 
 **Rules:**