diff --git a/README.md b/README.md index 4d1358dea..4aca55831 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,27 @@ We also have a free hosted version of Omnivore at [omnivore.app](https://omnivor omnivore-readme-screenshot -## Join us on Discord! +## Join us on Discord! :speech_balloon: We're building our community on Discord. [Join us!](https://discord.gg/h2z5rppzz9) Read more about Omnivore on our blog. -## How to setup local development +## Shoutouts :tada: + +Omnivore takes advantage of some great open source software: + +* [TypeScript](https://www.typescriptlang.org/) - Most of our backend and frontend are written in TypeScript. +* [Next.js](https://nextjs.org/) - Our frontend is a Next.JS app and is hosted on [Vercel](https://vercel.com/). +* [SWR](https://swr.vercel.app/) - We do all our data fetching on the web using SWR. +* [Stitches](https://stitches.dev/) - We use Stitches on the frontend to style our components. +* [Mozilla Readability](https://github.com/mozilla/readability) - We use Mozilla's Readability library to make pages easier to read. +* [Swift GraphQL](https://www.swift-graphql.com/) - We generate our GraphQL queries on iOS using Swift GraphQL. +* [Radix](https://www.radix-ui.com/) - We use Raxix UI's components on our frontend. +* And many more awesome libraries, just checkout our package files to see what we are using. + + +## How to setup local development :computer: The easiest way to get started with local development is to use `docker-compose up`. This will start a postgres container, our web frontend, an API server, and our content fetching microservice.