diff --git a/README.md b/README.md index bcfee1ea..c62c4d9f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,37 @@ [![CI](https://github.com/ravgeetdhillon/notion-feeder/actions/workflows/main.yml/badge.svg)](https://github.com/ravgeetdhillon/notion-feeder/actions/workflows/main.yml) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) # Notion Feeder A Node.js app for creating a Feed Reader in [Notion](https://notion.so). -## Prerequisites +![](/screenshots/working.gif) + +## Features + +Separate database for your feed sources and feed items. + +![](/screenshots/image-1.png) + +Add, enable and disbale your feed sources. + +![](/screenshots/image-2.png) + +Feeds sourced daily and stored in Reader database. New feed items are marked with 🔥. + +![](/screenshots/image-3.png) + +Read a feed directly in Notion Page View. + +![](/screenshots/image-4.png) + +Different views of accessing Unread, Starred feed items. + +![](/screenshots/image-5.png) + +## Development + +### Prerequisites These things are required before setting up the project. @@ -12,7 +39,7 @@ These things are required before setting up the project. - Ubuntu 18.04 or 20.04 - Node.js [Read Guide](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04) -## Getting Started +### Setup Follow these instructions to get the project up and running. diff --git a/screenshots/image-1.png b/screenshots/image-1.png new file mode 100644 index 00000000..c28786d1 Binary files /dev/null and b/screenshots/image-1.png differ diff --git a/screenshots/image-2.png b/screenshots/image-2.png new file mode 100644 index 00000000..9ac96892 Binary files /dev/null and b/screenshots/image-2.png differ diff --git a/screenshots/image-3.png b/screenshots/image-3.png new file mode 100644 index 00000000..30f7474a Binary files /dev/null and b/screenshots/image-3.png differ diff --git a/screenshots/image-4.png b/screenshots/image-4.png new file mode 100644 index 00000000..7520591d Binary files /dev/null and b/screenshots/image-4.png differ diff --git a/screenshots/image-5.png b/screenshots/image-5.png new file mode 100644 index 00000000..72b2afbc Binary files /dev/null and b/screenshots/image-5.png differ diff --git a/screenshots/working.gif b/screenshots/working.gif new file mode 100644 index 00000000..89db6647 Binary files /dev/null and b/screenshots/working.gif differ