diff --git a/README.md b/README.md index 6db11e0923..6116e327a0 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,21 @@ -## Welcome to Effect [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/Effect-TS/effect) +# Effect -Effect is an ecosystem of libraries to write highly productive, purely functional TypeScript at scale. +Welcome to Effect, a powerful TypeScript framework that provides a fully-fledged functional effect system with a rich standard library. -## Intro Talk - -[![Introduction to Effect](https://img.youtube.com/vi/zrNr3JVUc8I/maxresdefault.jpg)](https://youtu.be/zrNr3JVUc8I) +## Documentation -## Install +For detailed information and usage examples, please visit the [Effect website](https://www.effect.website/). -```sh -pnpm install effect -``` +## Intro Talk -## TSConfig +Watch our introduction to Effect on YouTube: -It's important to make sure 'strict' is enabled. +[![Introduction to Effect](https://img.youtube.com/vi/zrNr3JVUc8I/maxresdefault.jpg)](https://youtu.be/zrNr3JVUc8I) -## Documentation +## Get in touch -Coming soon. +Join our community on Discord: https://discord.gg/hdt7t7jpvn -## Get in touch +## API Reference -Join us using discord at: [https://discord.gg/hdt7t7jpvn](https://discord.gg/hdt7t7jpvn) +For detailed information on the Effect API, please refer to our [API Reference](https://effect-ts.github.io/effect/).