From 197e038f37c5edb09b1a196b61255b83aaaf4e41 Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 10:43:38 -0800 Subject: [PATCH 1/7] Add a section in the README on the OSS we use --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 4d1358dea..32ae41363 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,16 @@ We're building our community on Discord. [Join us!](https://discord.gg/h2z5rppzz Read more about Omnivore on our blog. +## Shoutouts + +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/) +* [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. + + ## How to setup local development 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. From 0313f3805e1c33f1c0a26690d90d92acfb17f9fe Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 10:53:17 -0800 Subject: [PATCH 2/7] Add emoji to the README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 32ae41363..9198208a8 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,13 @@ We also have a free hosted version of Omnivore at [omnivore.app](https://omnivor omnivore-readme-screenshot -## Join us on Discord! +## :speech_balloon: Join us on Discord! We're building our community on Discord. [Join us!](https://discord.gg/h2z5rppzz9) Read more about Omnivore on our blog. -## Shoutouts +## :tada: Shoutouts Omnivore takes advantage of some great open source software: @@ -46,7 +46,7 @@ Omnivore takes advantage of some great open source software: * [Mozilla Readability](https://github.com/mozilla/readability) - We use Mozilla's Readability library to make pages easier to read. -## How to setup local development +## :computer: How to setup local development 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. From ad507ec50769ada2e270fa5adb3feee6b782107d Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 10:56:11 -0800 Subject: [PATCH 3/7] Put the emoji after the headlines to make them a little more readable --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9198208a8..a0e64608f 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,13 @@ We also have a free hosted version of Omnivore at [omnivore.app](https://omnivor omnivore-readme-screenshot -## :speech_balloon: 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. -## :tada: Shoutouts +## Shoutouts :tada: Omnivore takes advantage of some great open source software: @@ -46,7 +46,7 @@ Omnivore takes advantage of some great open source software: * [Mozilla Readability](https://github.com/mozilla/readability) - We use Mozilla's Readability library to make pages easier to read. -## :computer: How to setup local development +## 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. From 376689ea633e80bb3b4ce4260906774a3b61e794 Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 10:58:44 -0800 Subject: [PATCH 4/7] README typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a0e64608f..cf9cc00dc 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ Read more about Omnivore on our blog. Date: Wed, 16 Feb 2022 11:07:04 -0800 Subject: [PATCH 5/7] Add Swift GraphQL to the shoutouts section --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cf9cc00dc..94a729106 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ Omnivore takes advantage of some great open source software: * [Next.js](https://nextjs.org/) - Our frontend is a Next.JS app and is hosted on [Vercel](https://vercel.com/). * [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. +* And many more awesome libraries, just checkout our package files to see what we are using. ## How to setup local development :computer: From 3d289f24be1f3a24e7698b79a1cdaca560430cce Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 11:10:44 -0800 Subject: [PATCH 6/7] Add Radix to the list of OSS we use --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 94a729106..b6398dd46 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ Omnivore takes advantage of some great open source software: * [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. From 01575e77802d0d72c150b90807ce2b9da87e6550 Mon Sep 17 00:00:00 2001 From: Jackson Harper Date: Wed, 16 Feb 2022 11:14:36 -0800 Subject: [PATCH 7/7] Add SWR --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b6398dd46..4aca55831 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ 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.