diff --git a/README.md b/README.md index 550f1a1d..7ecf06c7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,37 @@

- -

Streamplace

-

Solving Video for Everybody Forever

-

- stream.place | - Documentation | - Download -

+ Streamplace logo

+

Streamplace

+

Solving Video for Everybody Forever

-## Sponsorship +Welcome friends! This is the codebase for Streamplace, live video built on the +[AT Protocol](https://atproto.com), which is the same protocol that powers Bluesky. - +Get started fast: -Streamplace was generously funded by the Livepeer Treasury as part of their -mission to build the world's open video infrastructure. Check out more at -[livepeer.org](https://www.livepeer.org/)! +- **Web: [stream.place](https://stream.place)** +- **Download: [stream.place/download](https://stream.place/download)** +- **Docs: [stream.place/docs](https://stream.place/docs)** + +## Development Resources + +The server is written in Go (`pkg/`, `cmd/`) and the app is a +[React Native](https://reactnative.dev/) application in TypeScript (`js/`). +The `place.stream.*` Lexicons live in [`lexicons/`](lexicons/). + +You don't _need_ to understand the AT Protocol to work with Streamplace, but +it helps quite a lot. Learn more at [atproto.com](https://atproto.com/guides/overview). + +Good places to start: + +- [Quick start: streaming](https://stream.place/docs/guides/start-streaming/quick-start) +- [Development setup](https://stream.place/docs/guides/start-contributing/streamplace-dev-setup) +- [Self-hosting](https://stream.place/docs/guides/installing/installing-streamplace) +- [API reference](https://stream.place/docs/lex-reference/place-stream-defs) + +## Contributions + +Check for existing [issues](https://github.com/streamplace/streamplace/issues) +before filing a new one, and open an issue for discussion before submitting a +large PR. Questions and chat are welcome on +[Discord](https://discord.stream.place).